#26233 closed Uncategorized (fixed)
docstring of django.db.models.Q causes warning when building Sphinx docs for my project
Reported by: | Luc Saffre | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | 1.9 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Unreviewed | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
When I write
from django.db.models import Q
in my code, then I get a Sphinx warning when building the docs for my project. This is partly due to the fact that Sphinx's autodoc inserts the docstring of Django's Q class into my API doc. But the more obvious problem is that this docstring contains invalid reStructuredText content. The docstring is:
Encapsulates filters as objects that can then be combined logically (using & and |).
Correct syntax must be::
Encapsulates filters as objects that can then be combined logically (using `&` and `|`).
Attachments (1)
Note:
See TracTickets
for help on using tickets.
output of git diff