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@python
components: Documentation
messages: 272259
nosy: docs@python, ztane
priority: normal
severity: normal
status: open
title: decimal.Context.to_eng_string wrong docstring

_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue27720>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to