[docs] [issue27720] decimal.Context.to_eng_string wrong docstring
Antti Haapala
report at bugs.python.org
Tue Aug 9 13:25:19 EDT 2016
New submission from Antti Haapala:
https://docs.python.org/3/library/decimal.html#decimal.Context.to_eng_string
The docstring for `Context.to_eng_string` says "Converts a number to a string, using scientific notation.", which is, less extra comma, exactly the docstring for `Context.to_sci_string`. It should probably say "using engineering notation".
Additionally, docstring for Decimal.to_eng_string uses the term "an engineering-type string", which no one uses outside the said docstring. It should probably also say "Convert to a string using engineering notation."
----------
assignee: docs at python
components: Documentation
messages: 272259
nosy: docs at python, ztane
priority: normal
severity: normal
status: open
title: decimal.Context.to_eng_string wrong docstring
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue27720>
_______________________________________
More information about the docs
mailing list