[New-bugs-announce] [issue43570] pyspecific.py > AuditEvent mess with translations

[Julien Palard]

New submission from Julien Palard <julien+python at palard.fr>:

In case an `.. audit-event::` has a content, Sphinx gets confused:

It will provide both "auto-generated" and the content in po files, for interactivehook for example we have:

    #: library/sys.rst:953
    msgid ""
    "Raises an :ref:`auditing event <auditing>` ``cpython.run_interactivehook`` "
    "with argument ``hook``."
    msgstr ""

    #: library/sys.rst:955
    msgid ""
    "Raises an :ref:`auditing event <auditing>` ``cpython.run_interactivehook`` "
    "with the hook object as the argument when the hook is called on startup."
    msgstr ""
    "Lève un :ref:`évènement d'audit <auditing>` ``cpython.run_interactivehook`` "
    "avec l'objet de point d'entrée comme argument lorsqu'il est appelé au "
    "démarrage."

Which is not needed as only the content is used to render the doc, but it's the least issue. The issue is that Sphinx will then check the used one (content) against the translation of the auto-generated one leading it to trigger a warning on case the :ref: used don't match, typically for:


    .. audit-event:: sys.unraisablehook hook,unraisable sys.unraisablehook

       Raise an auditing event ``sys.unraisablehook`` with arguments
       ``hook``, ``unraisable`` when an exception that cannot be handled occurs.
       The ``unraisable`` object is the same as what will be passed to the hook.
       If no hook has been set, ``hook`` may be ``None``.

    
Sphinx will compare the auto-generated one:

    Raises an :ref:`auditing event <auditing>` ``sys.unraisablehook`` with arguments ``hook``, ``unraisable``.

Against our translated one (Lève un évènement d'audit ...).

Issue is, as in "Raise an auditing event" there's no :ref:, but as we translated "Raises an :ref:`auditing event <auditing>`" we used one, Sphinx whines about inconsistent term references.

As far as I understand it, it's related, or near, the:

    if self.content:
        self.state.nested_parse(self.content, self.content_offset, pnode)
    else:
        n, m = self.state.inline_text(text, self.lineno)
        pnode.extend(n + m)

part of pyspecific.py.

----------
assignee: docs at python
components: Documentation
messages: 389169
nosy: docs at python, mdk, steve.dower
priority: normal
severity: normal
status: open
title: pyspecific.py >  AuditEvent mess with translations
versions: Python 3.10, Python 3.9

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