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.

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

Nightly wrap_comments can break code blocks #6255

Closed
VorpalBlade opened this issue Jul 28, 2024 · 1 comment
Closed

Nightly wrap_comments can break code blocks #6255

VorpalBlade opened this issue Jul 28, 2024 · 1 comment
Labels
a-comments a-markdown markdown formatting in doc comments duplicate only-with-option requires a non-default option value to reproduce

Comments

@VorpalBlade
Copy link

VorpalBlade commented Jul 28, 2024

Given:

    /// To add a key compatible with the above service and user run a command like the following:
    /// ```console
    /// $ secret-tool store --label="Descriptive name" service chezmoi-modify-manager username konversation-login
    /// ```

wrap_comments reformats this to:

    /// To add a key compatible with the above service and user run a command
    /// like the following: ```console
    /// $ secret-tool store --label="Descriptive name" service chezmoi-modify-manager username konversation-login
    /// ```

It should instead be reformatted to:

    /// To add a key compatible with the above service and user run a command
    /// like the following:
    /// ```console
    /// $ secret-tool store --label="Descriptive name" service chezmoi-modify-manager username konversation-login
    /// ```

This relates to #3347

@ytmimi ytmimi added duplicate a-comments only-with-option requires a non-default option value to reproduce a-markdown markdown formatting in doc comments labels Aug 3, 2024
@ytmimi
Copy link
Contributor

ytmimi commented Aug 3, 2024

Closing this as a duplicate of #5244

@ytmimi ytmimi closed this as not planned Won't fix, can't repro, duplicate, stale Aug 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-comments a-markdown markdown formatting in doc comments duplicate only-with-option requires a non-default option value to reproduce
Projects
None yet
Development

No branches or pull requests

2 participants