➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author erlendaasland
Recipients docs@python, erlendaasland
Date 2021-10-29.21:55:04
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1635544504.5.0.82834028892.issue45677@roundup.psfhosted.org>
In-reply-to
Content 
The sqlite3 docs could need a little makeover. Here's some things that could be improved:

- avoid addressing the reader as "you"
- avoid using affirmative tone
- establish a "Security Considerations" or "Common Mistakes" section, instead of littering the docs with warnings


See also:
- https://devguide.python.org/documenting/#style-guide
History
Date User Action Args
2021-10-29 21:55:04erlendaaslandsetrecipients: + erlendaasland, docs@python
2021-10-29 21:55:04erlendaaslandsetmessageid: <1635544504.5.0.82834028892.issue45677@roundup.psfhosted.org>
2021-10-29 21:55:04erlendaaslandlinkissue45677 messages
2021-10-29 21:55:04erlendaaslandcreate