diff options
| -rw-r--r-- | changelog/README.rst | 15 |
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- |