summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamesh Lakhotia <43701530+sameshl@users.noreply.github.com>2019-07-31 23:09:02 +0530
committerSebastian Berg <sebastian@sipsolutions.net>2019-07-31 10:39:02 -0700
commit8eafe99694759d6589bc79b8f7a9410fac3a2cba (patch)
tree149510f49cd5c9cea0694fbc2e1d8ecc81f99b94
parentf12c63297fecdff294af209032d0690c6c2a1c0d (diff)
downloadnumpy-8eafe99694759d6589bc79b8f7a9410fac3a2cba.tar.gz
DOC: fix markup of news fragment readme (gh-14115)
fixed reST formatting typo in changelog/README.md. Looked like there was an extra pair of ```
-rw-r--r--changelog/README.rst15
1 files changed, 7 insertions, 8 deletions
diff --git a/changelog/README.rst b/changelog/README.rst
index 95b0b20a8..03f020c1e 100644
--- a/changelog/README.rst
+++ b/changelog/README.rst
@@ -24,14 +24,13 @@ Each file should be named like ``<PULL REQUEST>.<TYPE>.rst``, where
* ``improvements``: Performance and edge-case changes
* ``changes``: Other changes
-So for example: ``123.new_features.rst`` would have the content:
-
-```
-my_new_feature option for `my_favorite_function`
-------------------------------------------------
-The ``my_new_feature`` option is now available for `my_favorite_function`.
-To use it, write ``np.my_favorite_function(..., my_new_feature=True)``.
-```
+So for example: ``123.new_features.rst`` would have the content::
+
+ my_new_feature option for `my_favorite_function`
+ ------------------------------------------------
+ The ``my_new_feature`` option is now available for `my_favorite_function`.
+ To use it, write ``np.my_favorite_function(..., my_new_feature=True)``.
+
Note the use of single-backticks to get an internal link (assuming
``my_favorite_function`` is exported from the ``numpy`` namespace), and double-