From db4939f00756d16e1ada3af22e183e4492836507 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A9n=C3=A9dikt=20Tran?= <10796600+picnixz@users.noreply.github.com> Date: Fri, 5 Apr 2024 13:32:55 +0200 Subject: [PATCH] [misc] update wording of ``versionadded`` to ``Added in [...]`` (#12184) Motivated by the community feedback, the wording of ``versionadded`` is changed from ``New in [...]`` to ``Added in [...]``. --- CHANGES.rst | 5 +++++ sphinx/domains/changeset.py | 2 +- sphinx/util/nodes.py | 2 +- tests/test_builders/test_build_changes.py | 2 +- tests/test_builders/test_build_html_5_output.py | 2 +- tests/test_intl/test_intl.py | 2 +- 6 files changed, 10 insertions(+), 5 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 3becdc1db2d..a02119c1e7e 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -57,6 +57,11 @@ Features added .. _OSC 8: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda .. _groff: https://lists.gnu.org/archive/html/groff/2021-10/msg00000.html +* #11015: :rst:dir:`versionadded` wording changes from ``New in [...]`` + to ``Added in [...]``. + Patch by Bénédikt Tran. + + Bugs fixed ---------- diff --git a/sphinx/domains/changeset.py b/sphinx/domains/changeset.py index c0550f5b478..5ffabcf5044 100644 --- a/sphinx/domains/changeset.py +++ b/sphinx/domains/changeset.py @@ -20,7 +20,7 @@ versionlabels = { - 'versionadded': _('New in version %s'), + 'versionadded': _('Added in version %s'), 'versionchanged': _('Changed in version %s'), 'deprecated': _('Deprecated since version %s'), 'versionremoved': _('Removed in version %s'), diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index 3cf199a8f7f..bbc1f64e481 100644 --- a/sphinx/util/nodes.py +++ b/sphinx/util/nodes.py @@ -110,7 +110,7 @@ def get_full_module_name(node: Node) -> str: def repr_domxml(node: Node, length: int = 80) -> str: """ return DOM XML representation of the specified node like: - 'New in version...' + 'Added in version...' :param nodes.Node node: target node :param int length: diff --git a/tests/test_builders/test_build_changes.py b/tests/test_builders/test_build_changes.py index b340c8d54ec..b537b8751ae 100644 --- a/tests/test_builders/test_build_changes.py +++ b/tests/test_builders/test_build_changes.py @@ -9,7 +9,7 @@ def test_build(app): # TODO: Use better checking of html content htmltext = (app.outdir / 'changes.html').read_text(encoding='utf8') - assert 'New in version 0.6: Some funny stuff.' in htmltext + assert 'Added in version 0.6: Some funny stuff.' in htmltext assert 'Changed in version 0.6: Even more funny stuff.' in htmltext assert 'Deprecated since version 0.6: Boring stuff.' in htmltext diff --git a/tests/test_builders/test_build_html_5_output.py b/tests/test_builders/test_build_html_5_output.py index 0350efd67b7..ece6f495a95 100644 --- a/tests/test_builders/test_build_html_5_output.py +++ b/tests/test_builders/test_build_html_5_output.py @@ -113,7 +113,7 @@ def checker(nodes): # abbreviations ('markup.html', ".//abbr[@title='abbreviation']", '^abbr$'), # version stuff - ('markup.html', ".//div[@class='versionadded']/p/span", 'New in version 0.6: '), + ('markup.html', ".//div[@class='versionadded']/p/span", 'Added in version 0.6: '), ('markup.html', ".//div[@class='versionadded']/p/span", tail_check('First paragraph of versionadded')), ('markup.html', ".//div[@class='versionchanged']/p/span", diff --git a/tests/test_intl/test_intl.py b/tests/test_intl/test_intl.py index e54339c1220..6b1e9bae046 100644 --- a/tests/test_intl/test_intl.py +++ b/tests/test_intl/test_intl.py @@ -967,7 +967,7 @@ def get_content(result, name): assert expect1 == matched_content expect2 = ( - """

New in version 1.0: """ + """

Added in version 1.0: """ """THIS IS THE FIRST PARAGRAPH OF VERSIONADDED.

\n""") matched_content = get_content(result, "versionadded") assert expect2 == matched_content