Skip to content

Should What's New always use :verbatim:? #10123

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

Jump to bottom
Open
jsignell opened this issue Mar 13, 2025 · 0 comments
Open

Should What's New always use :verbatim:? #10123

jsignell opened this issue Mar 13, 2025 · 0 comments
Labels
topic-documentation

Comments

@jsignell
Copy link
Contributor

What is your issue?

I just ran into an issue on #10062 where some examples in What's New were breaking. I fixed it by adding :verbatim: and it made me think that that should maybe be the general recommendation for that particular docs file.

The whole concept of a changelog is that is a historical document so it makes sense to me that it would want to capture any examples as they worked that the time of writing.
@jsignell jsignell added the needs triage Issue that has not been reviewed by xarray team member label Mar 13, 2025
@jsignell jsignell mentioned this issue Mar 13, 2025
Open
4 tasks
@TomNicholas TomNicholas added topic-documentation and removed needs triage Issue that has not been reviewed by xarray team member labels Mar 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
topic-documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jsignell @TomNicholas