Skip to content

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

Open
@jsignell

Description

@jsignell

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions