pyspecific.py > AuditEvent mess with translations #87736

Activity

1. JulienPalard commented on Mar 20, 2021

   

   JulienPalard

   on Mar 20, 2021

   MemberAuthor

   More actions

   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.
2. JulienPalard

   added

   3.9 (EOL)end of lifeend of life

   3.10 (EOL)end of lifeend of life

   on Mar 20, 2021
3. JulienPalard

   assigned

   docspython

   on Mar 20, 2021
4. JulienPalard

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   3.9 (EOL)end of lifeend of life

   3.10 (EOL)end of lifeend of life

   on Mar 20, 2021
5. JulienPalard

   assigned

   docspython

   on Mar 20, 2021
6. JulienPalard

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on Mar 20, 2021
7. ezio-melotti

   transferred this issue fromon Apr 10, 2022
8. AA-Turner commented on Sep 22, 2023

   

   AA-Turner

   on Sep 22, 2023

   Member

   More actions

   Might've been fixed by #19470?

   A

   👍React with 👍1Reacted by W. H. Wang
9. StanFromIreland

   added this to Translation issues & improvements 🌍on Oct 1, 2025
10. StanFromIreland commented on Oct 1, 2025

    

    StanFromIreland

    on Oct 1, 2025

    Member

    More actions

    No longer an issue, just the intended text is extracted (example).
11. StanFromIreland

    closed this as a duplicateof pyspecific directives are not translatable #84435 on Oct 1, 2025
12. github-project-automation

    moved this to Done in Translation issues & improvements 🌍on Oct 1, 2025