Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example whatsnew file #2418

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add example whatsnew file #2418

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/sphinx/source/whatsnew/v0.X.Y-example.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
.. _whatsnew_0XXYY:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. _whatsnew_0XXYY:
.. _whatsnew_0_X_Y:

This is just personal taste, IK it's not the legacy form, but easier to read.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also prefer underscores. But what is the purpose of this tag and where does it show up (it at all)?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the hyperlink target, you would use it in rST like :ref:`whatsnew_0_X_Y`



v0.X.Y (Month XX, 20YY)
-----------------------

Breaking Changes
~~~~~~~~~~~~~~~~


Deprecations
~~~~~~~~~~~~


Bug fixes
~~~~~~~~~


Enhancements
~~~~~~~~~~~~


Documentation
~~~~~~~~~~~~~


Testing
~~~~~~~


Benchmarking
~~~~~~~~~~~~


Requirements
~~~~~~~~~~~~


Maintenance
~~~~~~~~~~~


Contributors
~~~~~~~~~~~~