Prettydocs #2762
Merged
Prettydocs #2762
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1. make /// ... and //! ... and /** ... */ and /*! ... */ into sugar for #[doc = ...] attributes. 2. add a script in etc/ to help converting doc-attributes to doc-comments 3. add some functions to core::str to help with (1)
…id a conflict with the new single-line-sugared-inner-doc-comment (`//! ...`).
|
I've merged this. Will you follow up with the conversion of existing doc attributes to doc comments? |
|
@brson Thanks for merging it. I will submit a new pull request for the conversion of existing comments. |
oli-obk
pushed a commit
to oli-obk/rust
that referenced
this pull request
Jan 30, 2023
RalfJung
pushed a commit
to RalfJung/rust
that referenced
this pull request
Feb 26, 2023
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Work for issue #2498.
Notes:
//~ ERRORinstead of//! ERRORto work around a conflict with the sugared doc syntax.etc/sugarise-doc-comments.pyto convert unsugared doc attributes, but I have not actually committed the results of running this script. I did not want the pull request to become too large and prone to merge conflicts (although I had to update the test suite in order tomake check). It handles 95% of cases but will require some manual editing to deal with (mostly) lines that become too long.