DOC: distutils: Add a docstring to show_config(). #15429
Conversation
numpy/distutils/misc_util.py
Outdated
| Notes | ||
| ----- | ||
| Classes specifying the information to be printed are defined | ||
| in the ``numpy.distutils.system_info`` module. |
There was a problem hiding this comment.
| in the ``numpy.distutils.system_info`` module. | |
| in the `numpy.distutils.system_info` module. |
Should produce a link here
numpy/distutils/misc_util.py
Outdated
| @@ -2326,6 +2326,43 @@ def get_info(name): | |||
| return g.get(name, g.get(name + "_info", {})) | |||
|
|
|||
| def show(): | |||
| """ | |||
| Print information about BLAS and LAPACK libraries in use. | |||
There was a problem hiding this comment.
Or maybe
| Print information about BLAS and LAPACK libraries in use. | |
| Print information about libraries NumPy was built against. |
Am I right in thinking this indicates what numpy actually uses? Or does it indicate what rebuilding numpy would use?
There was a problem hiding this comment.
That change looks good to me. I don't know the answer to those questions; I was assuming it shows what is being used by the numpy that ran show_config(). I'll take a look at the system_info module now.
There was a problem hiding this comment.
Worth checking before talking my suggestion :)
There was a problem hiding this comment.
It looks like it searches the system for the available libraries. Seems like a better name would be something like show_system_info() (which matches the underlying class that contains the code that does the work) or show_available_library_info(). Anyway, I'll fix the text.
|
I think we're missing something here. |
|
|
||
| Examples | ||
| -------- | ||
| >>> np.show_config() |
There was a problem hiding this comment.
This is not the function that this docstring is attached to.
There was a problem hiding this comment.
show_config is the new name given to show when it is imported into the numpy namespace (in numpy/__init__.py). I don't know why it isn't called show_config in __config__.py.
There was a problem hiding this comment.
Isn't np.show_config == np.__config__.show? This file is not np.__config__.
Yes, thanks for the reminder. I lost that point for a bit. |
|
How about for the one-line summary? |
|
I think:
|
|
I updated the one line summary. I'm not sure what the other change is that you are suggesting. in There is no |
|
Apologies, I did not expand the diff context enough to see this was part of a large string. |
Thanks to Sergey Kojoian for the original patch to create the docstring. Closes numpygh-9258.
6f35401 to
6d0b0b4
Compare
|
I squashed the two follow-up commits, and it looks like shippable has come back to life, so the tests have finally all passed. @eric-wieser, I'm not sure if there are still changes that you'd like to see. |
|
Looks good to me: https://11552-908607-gh.circle-artifacts.com/0/home/circleci/repo/doc/build/html/reference/generated/numpy.show_config.html#numpy.show_config Shame the link didn't work out, but I'm not worried. |
Thanks to Sergey Kojoian for the original patch to create
the docstring.
Closes gh-9258.