#30255: docutils reports an error rendering view docstring when the first line
is
not empty
-------------------------------------+-------------------------------------
Reporter: Manlio Perillo | Owner: Hasan
| Ramezani
Type: Bug | Status: assigned
Component: contrib.admindocs | Version: 3.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Baptiste Mispelon):
* has_patch: 0 => 1
* version: 2.1 => 3.0
Comment:
After a bit of trial and error, I finally managed to reproduce the issue
on current master with an up-to-date version of `docutils`.
The trick was to use a docstring like this: `"firstline\n\n second
line"` and not the one mentioned in the original report.
I took Simon's suggestion from comment 2 and removed `trim_docstring` in
favor of `inspect.cleandoc` and it fixes the issue.
[https://github.com/django/django/pull/12155 PR here]
--
Ticket URL: <https://code.djangoproject.com/ticket/30255#comment:8>
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/065.13e03c216219d9def269a1a8d41c46e3%40djangoproject.com.
