show_config() has no docstring and is not in the online docs. #9258

Activity

1. rgommers

   added

   04 - Documentation

   Easy Fix

   on Jun 16, 2017
3. rgommers commented on Jun 20, 2017

   

   rgommers

   on Jun 20, 2017

   Member

   More actions

   Thanks for working on this @siryog90. Looks like a good start. A couple of comments:

   • in the system. --> add something like "on which numpy was built"
   • Formatting: docstrings should start with a single summary line, then a blank line, then a description. Format is documented in detail in https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
   • Last 6 lines: make this a list, otherwise the formatting will be messed up.
   • The last 10 lines are not part of Examples but of Notes (which goes above Examples).
   • A See Also section with a link to get_include would be nice. There may be another function of interest, can't think of any right now though.
   • There was a mailing list discussion a while back about show_config and what it was lacking - would be nice to dig that up. I can look for it later if you can't find it.
5. rgommers commented on Jun 21, 2017

   

   rgommers

   on Jun 21, 2017

   Member

   More actions

   Just this will create a link:

   See Also
   --------
   get_include
   

   and optional, you can add a one-line description of how it's related:

   See Also
   --------
   get_include : some text here
   
6. rgommers commented on Jun 21, 2017

   

   rgommers

   on Jun 21, 2017

   Member

   More actions

   Adding numpy.distutils.system_info.get_info: not quite sure about that one. It doesn't have a docstring at the moment. If it did and it clearly explained the purpose, then indeed would be nice.
7. rgommers commented on Jun 21, 2017

   

   rgommers

   on Jun 21, 2017

   Member

   More actions

   That whole docstring looks pretty close to ready. I suggest you pop it into a PR!
9. orbit-stabilizer commented on Nov 21, 2017

   

   orbit-stabilizer

   on Nov 21, 2017

   Contributor

   More actions

   Should this issue be closed?
10. eric-wieser commented on Feb 27, 2018

    

    eric-wieser

    on Feb 27, 2018

    Last edited by eric-wieser

    Member

    More actions

    @orbit-stabilizer: No, the patch at #9312 needs a fixup
11. SahanaJavgal commented on Mar 31, 2019

    

    SahanaJavgal

    on Mar 31, 2019

    More actions

    Hello, Im new to Open Source and I am Applying for Outreachy. I would like to work on this Issue. Could you please assign it to me
12. mattip commented on Mar 31, 2019

    

    mattip

    on Mar 31, 2019

    Member

    More actions

    @SahanaJavgal work on this has already begun in #9312. No need to duplicate effort
13. eric-wieser

    closed this as completedin #15429on Jan 27, 2020