DOC: docstring for show_config. #9275
Conversation
There was a problem hiding this comment.
Thanks @siryog90. In addition to my minor comments on content/formatting, it would be good to ensure that this actually ends up in the html docs. Probably the best place to put it is in the packaging section (although other suggestions welcome): file:///home/rgommers/Code/numpy/doc/build/html/reference/distutils.html
Edit doc/source/reference/distutils.rst to get it there. The ``get_include function can also be added at the same time, it's not present in the docs under that name
numpy/distutils/misc_util.py
Outdated
|
|
||
| Examples | ||
| -------- | ||
| >>> import numpy as np |
There was a problem hiding this comment.
this import isn't needed, it's assumed in every example.
numpy/distutils/misc_util.py
Outdated
| Examples | ||
| -------- | ||
| >>> import numpy as np | ||
| >>> np.__config__.show() |
There was a problem hiding this comment.
Should be np.show_config because that's the public function.
numpy/distutils/misc_util.py
Outdated
| Notes | ||
| ----- | ||
| Classes specifying the information to be printed are defined | ||
| in the ``numpy.distuitls.system_info`` module. |
There was a problem hiding this comment.
- typo in
distuilts - use single backticks, then it will be rendered as a link
numpy/distutils/misc_util.py
Outdated
| Classes specifying the information to be printed are defined | ||
| in the ``numpy.distuitls.system_info`` module. | ||
|
|
||
| Information may include: |
There was a problem hiding this comment.
Needs a blank line here I think, for the list to render correctly
numpy/distutils/misc_util.py
Outdated
| in the ``numpy.distuitls.system_info`` module. | ||
|
|
||
| Information may include: | ||
| * language: language used to write the libraries (mostly C or f77) |
There was a problem hiding this comment.
suggest to use double backticks around each name before the colon, so those are typeset as code.
numpy/distutils/misc_util.py
Outdated
|
|
||
| Information is grouped according to classes (``blas_opt_info`` in the example) | ||
| that specify relevant resources, and it is formatted to be compatible with | ||
| ``distutils.setup`` keyword arguments. |
There was a problem hiding this comment.
I don't think this last sentence is correct, there are no such keywords for setup. They are there for add_library and add_extension though, so I guess that's what you meant. It's not super important I think, so suggest moving to the end of the Notes section.
|
I think it may be better to create a Build system info functions (maybe a more appropriate name?) subsection of routines and put the documentation there, since Edit: Better yet, how about putting it in Miscellaneous routines ? |
|
Docstring looks good to me now. Miscellaneous routines seems like a good place. You still have to add |
|
@rgommers The docs say that Do I need to make the table manually? |
ghost
closed this
ghost
deleted the
|
Hmm... |
|
@siryog90 what's going on? You were close to done, and now it looks like you've deleted your branch. |
ghost
mentioned this pull request
A docstring for
show_config(alias for the functionshow).