Skip to content

Commit db4939f

Browse files
authored
[misc] update wording of versionadded to Added in [...] (sphinx-doc#12184)
Motivated by the community feedback, the wording of ``versionadded`` is changed from ``New in [...]`` to ``Added in [...]``.
1 parent 17a84a6 commit db4939f

File tree

6 files changed

+10
-5
lines changed

6 files changed

+10
-5
lines changed

CHANGES.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@ Features added
5757
.. _OSC 8: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
5858
.. _groff: https://lists.gnu.org/archive/html/groff/2021-10/msg00000.html
5959

60+
* #11015: :rst:dir:`versionadded` wording changes from ``New in [...]``
61+
to ``Added in [...]``.
62+
Patch by Bénédikt Tran.
63+
64+
6065
Bugs fixed
6166
----------
6267

sphinx/domains/changeset.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121

2222
versionlabels = {
23-
'versionadded': _('New in version %s'),
23+
'versionadded': _('Added in version %s'),
2424
'versionchanged': _('Changed in version %s'),
2525
'deprecated': _('Deprecated since version %s'),
2626
'versionremoved': _('Removed in version %s'),

sphinx/util/nodes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ def get_full_module_name(node: Node) -> str:
110110
def repr_domxml(node: Node, length: int = 80) -> str:
111111
"""
112112
return DOM XML representation of the specified node like:
113-
'<paragraph translatable="False"><inline classes="versionmodified">New in version...'
113+
'<paragraph translatable="False"><inline classes="versionadded">Added in version...'
114114
115115
:param nodes.Node node: target node
116116
:param int length:

tests/test_builders/test_build_changes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def test_build(app):
99

1010
# TODO: Use better checking of html content
1111
htmltext = (app.outdir / 'changes.html').read_text(encoding='utf8')
12-
assert 'New in version 0.6: Some funny stuff.' in htmltext
12+
assert 'Added in version 0.6: Some funny stuff.' in htmltext
1313
assert 'Changed in version 0.6: Even more funny stuff.' in htmltext
1414
assert 'Deprecated since version 0.6: Boring stuff.' in htmltext
1515

tests/test_builders/test_build_html_5_output.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ def checker(nodes):
113113
# abbreviations
114114
('markup.html', ".//abbr[@title='abbreviation']", '^abbr$'),
115115
# version stuff
116-
('markup.html', ".//div[@class='versionadded']/p/span", 'New in version 0.6: '),
116+
('markup.html', ".//div[@class='versionadded']/p/span", 'Added in version 0.6: '),
117117
('markup.html', ".//div[@class='versionadded']/p/span",
118118
tail_check('First paragraph of versionadded')),
119119
('markup.html', ".//div[@class='versionchanged']/p/span",

tests/test_intl/test_intl.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -967,7 +967,7 @@ def get_content(result, name):
967967
assert expect1 == matched_content
968968

969969
expect2 = (
970-
"""<p><span class="versionmodified added">New in version 1.0: </span>"""
970+
"""<p><span class="versionmodified added">Added in version 1.0: </span>"""
971971
"""THIS IS THE <em>FIRST</em> PARAGRAPH OF VERSIONADDED.</p>\n""")
972972
matched_content = get_content(result, "versionadded")
973973
assert expect2 == matched_content

0 commit comments

Comments
 (0)