[New-bugs-announce] [issue45677] [doc] improve sqlite3 docs

Erlend E. Aasland report at bugs.python.org
Fri Oct 29 17:55:04 EDT 2021


New submission from Erlend E. Aasland <erlend.aasland at innova.no>:

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

----------
assignee: docs at python
components: Documentation
messages: 405349
nosy: docs at python, erlendaasland
priority: normal
severity: normal
status: open
title: [doc] improve sqlite3 docs
versions: Python 3.10, Python 3.11, Python 3.9

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue45677>
_______________________________________


More information about the New-bugs-announce mailing list