classification
Title: improve docstrings of sys.float_info
Type: enhancement Stage:
Components: Documentation Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, mark.dickinson, nanjekyejoannah, sir-sigurd
Priority: normal Keywords:

Created on 2019-08-29 03:16 by sir-sigurd, last changed 2019-08-29 16:58 by nanjekyejoannah.

Messages (5)
msg350703 - (view) Author: Sergey Fedoseev (sir-sigurd) * Date: 2019-08-29 03:16
In [8]: help(sys.float_info)

...

 |  
 |  dig
 |      DBL_DIG -- digits
 |

This is not very helpful, https://docs.python.org/3/library/sys.html#sys.float_info is more verbose, so probably docstrings should be updated from where.
msg350756 - (view) Author: Mark Dickinson (mark.dickinson) * (Python committer) Date: 2019-08-29 08:29
Unhelpful indeed. +1 to updating those docstrings to match the details at docs.python.org.
msg350801 - (view) Author: Joannah Nanjekye (nanjekyejoannah) * (Python committer) Date: 2019-08-29 16:41
See also #37970
msg350804 - (view) Author: Mark Dickinson (mark.dickinson) * (Python committer) Date: 2019-08-29 16:52
@nanjekyejoannah I'm not seeing how that issue is related to this one (except that they're both about docstrings). Can you elaborate?
msg350805 - (view) Author: Joannah Nanjekye (nanjekyejoannah) * (Python committer) Date: 2019-08-29 16:58
I just referenced another area that may need help updating/improving doc strings.
History
Date User Action Args
2019-08-29 16:58:46nanjekyejoannahsetmessages: + msg350805
2019-08-29 16:52:21mark.dickinsonsetmessages: + msg350804
2019-08-29 16:41:25nanjekyejoannahsetnosy: + nanjekyejoannah
messages: + msg350801
2019-08-29 08:29:06mark.dickinsonsetnosy: + mark.dickinson
messages: + msg350756
2019-08-29 03:16:57sir-sigurdcreate