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

Jump to bottom

Add support for multi-line doc strings #44

Open
JonathanWoollett-Light opened this issue Sep 19, 2023 · 0 comments
Open

Add support for multi-line doc strings #44

JonathanWoollett-Light opened this issue Sep 19, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@JonathanWoollett-Light
Copy link

JonathanWoollett-Light commented Sep 19, 2023 •
edited
Loading

Currently when multi-line doc strings are used the error message

Multi-line comments are disabled by default by displaydoc. Please consider using block doc comments (/** */) or adding the #[ignore_extra_doc_attributes] attribute to your type next to the derive.

is output.

This create an issue where cargo fmt as used on a repo may enforce using /// comments which creates a conflict.

It would be better to collect these lines into a string, e.g.

#[doc="first\nsecond"]
@yaahc yaahc added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@yaahc @JonathanWoollett-Light