#36124: Importing from django.contrib.admindocs.views modifies docutils rst
parser
-------------------------------------+-------------------------------------
Reporter: Michal Čihař | Owner: (none)
Type: | Status: closed
Cleanup/optimization |
Component: contrib.admindocs | Version: dev
Severity: Normal | Resolution: needsinfo
Keywords: docutils | Triage Stage:
simplify_regex roles | Unreviewed
register_canonical_role |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Natalia Bidart):
* keywords: => docutils simplify_regex roles register_canonical_role
* resolution: => needsinfo
* status: new => closed
* type: Uncategorized => Cleanup/optimization
* version: 5.1 => dev
Comment:
Replying to [ticket:36124 Michal Čihař]:
Hello Michal, thank you for taking the time to create this ticket.
> Doing `from django.contrib.admindocs.views import simplify_regex` is
enough to make admindocs customize docutils rst parser what might have
undesired side effects.
I see your point, but I also see that Django registers a specific role,
with a non common name `cmsreference`. Could you provide more details on
how this would produce undesired side effects (other than having a new
role defined)?
> Not sure if this interface is considered public or not, but apparently
it got some users.
This interface is definitely NOT considered public, is not documented nor
advertised in any way.
> Would it be possible to separate simplify_regex logic to some utility
module that could be reused by others and would not suffer such side
effects? Any other ideas how to address this?
For questions like this, the
[https://forum.djangoproject.com/c/internals/5 Django Forum] would be a
great place to seek feedback and suggestions. The forum is read by a
broader audience, including contributors and users who can provide a wider
range of insights and potential solutions. This ticket tracker, on the
other hand, is primarily followed by the Django Fellows, so you might not
receive as much input from the broader community here.
I'll be closing this ticket as `needsinfo` following the
[https://docs.djangoproject.com/en/dev/internals/contributing/triaging-
tickets/#closing-tickets ticket triaging process]. To me, while the
potential for undesirable side effects exists, these appear to be
theoretical at this point. In order to fully understand the scope of the
issue, we would need to investigate specific use cases and determine under
what conditions this could become problematic, so please reopen when you
can provide further details.
Thanks again!
--
Ticket URL: <https://code.djangoproject.com/ticket/36124#comment:1>
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 view this discussion visit
https://groups.google.com/d/msgid/django-updates/010701948e1c3f6b-ef069aed-0b9c-46b9-a7a4-a69fc3c05124-000000%40eu-central-1.amazonses.com.
