#26233: docstring of django.db.models.Q causes warning when building Sphinx docs
for my project
-------------------------------+--------------------
Reporter: lsaffre | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.9
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+--------------------
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 `|`).
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/26233>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/050.8beade44fcab98d5eba4e581a4ba9656%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
