[docs] Formatting of True/False in docs (issue 19795)

georg at python.org georg at python.org
Tue Nov 26 21:00:48 CET 2013


http://bugs.python.org/review/19795/diff/10113/Doc/library/logging.rst
File Doc/library/logging.rst (right):

http://bugs.python.org/review/19795/diff/10113/Doc/library/logging.rst#newcode163
Doc/library/logging.rst:163: ``False``. If specified as True, stack
information is added to the logging
On 2013/11/26 20:56:30, storchaka wrote:
> On 2013/11/26 18:37:58, Georg wrote:
> > you missed a True here
> 
> I doubt about wording. Any true value means same as ``True`` in
boolean context.
> But "as true" perhaps doesn't sound right. Could you please propose
right
> wording?

Just "If true" should be good.

http://bugs.python.org/review/19795/diff/10113/Doc/library/sqlite3.rst
File Doc/library/sqlite3.rst (right):

http://bugs.python.org/review/19795/diff/10113/Doc/library/sqlite3.rst#newcode245
Doc/library/sqlite3.rst:245: can call this function with *flag* as true.
Afterwards, you will get tracebacks
On 2013/11/26 20:56:30, storchaka wrote:
> On 2013/11/26 18:37:58, Georg wrote:
> > "with flag as true" doesn't sound right -- this could be formulated
> differently
> > while you're at it
> 
> I can't do this. Could you please propose better wording?

Hmm, what about

"you can call this function with *flag* set to ``True``"

http://bugs.python.org/review/19795/


More information about the docs mailing list