[docs] [issue9305] Don't use east/west of UTC in date/time documentation
anatoly techtonik
report at bugs.python.org
Tue Jul 20 18:08:08 CEST 2010
anatoly techtonik <techtonik at gmail.com> added the comment:
> Documenting utcoffset() as "Return timedelta equal to local UTC
> offset." is almost circular. It does not explain whether it has to be
> added or subtracted from UTC to arrive at local time.
Ok. Sold.
>> I believe the correct convention is "Return timedelta...".
>
> This is handled inconsistently in the documentation; I'm hoping the
> current maintainers reinforce the "Returns ..." structure. The
> documentation is descriptive, not an external specification.
http://www.python.org/dev/peps/pep-0257/#one-line-docstrings
I've took the convention from here. I thought docs are generated from
docstrings.
----------
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9305>
_______________________________________
More information about the docs
mailing list