@@ -202,35 +202,19 @@ So a file name may be
202202The contents of a news file should be valid reStructuredText. An 80 character
203203column width should be used. There is no indentation or leading marker in the
204204file (e.g. ``- ``). There is also no need to start the entry with the issue
205- number as it's part of the file name itself. Example news entry::
206-
207- Fix warning message when ``os.chdir()`` fails inside
208- ``test.support.temp_cwd()``. Patch by Chris Jerdonek.
209-
210- In addition to inline reST, news entries also support the usage of
211- `Sphinx roles <https://devguide.python.org/documenting/#id4 >`_. Several
212- commonly used roles include :func: , :class: , and :meth: . When a
213- corresponding entry is found within the documentation, the text within
214- the role is converted into a hyperlink. Example news entry with Sphinx::
205+ number as it's part of the file name itself. You can use
206+ :ref: `inline markups <rest-inline-markup >` too. Example news entry::
215207
216208 Fix warning message when :func:`os.chdir` fails inside
217209 :func:`test.support.temp_cwd`. Patch by Chris Jerdonek.
218210
219- The inline Sphinx roles can be used to assist readers in finding more
220- information and context on the changes made. If the inline link does not
221- provide additional context, an inline reST code block can be used instead::
222-
223- ``<object>``
211+ The inline Sphinx roles like ``:func: `` can be used to assist readers in finding
212+ more information. You can build html and verify that the link target is
213+ appropriate by using :ref: `make html <building-using-make >`.
224214
225- Before using any Sphinx roles, ensure that a corresponding entry exists
226- within the documentation. When adding rich formatting to news entries,
227- use the netlify deploy preview to verify that the documentation was
228- appropriately modified. Alternatively, `make html
229- <https://devguide.python.org/documenting/#using-make-make-bat> `_
230- can be used instead.
215+ While Sphinx roles can be beneficial to readers, they are not required.
216+ Inline ````code blocks`` `` can be used instead.
231217
232- The Sphinx roles can be beneficial to readers, but they are not required.
233- Inline code blocks can be used as a viable substitute.
234218
235219Working with Git _
236220-----------------
0 commit comments