Improve handling of inner docstring comments #103
Merged
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.
This PR fixes #102.
At a high level, this PR stops treating
///
-prefixed docstring comments as comments, but as a syntactic structure of their own.In essence, docstrings can only be used wherever an
attr
can be used (it might even be a subset of those cases, but handling it wherever attributes are handled should handle all important cases, since///
docstring comments are essentially syntax sugar for the#[doc(...)]
attribute).By removing it from normal comment handling, we gain more control over them, and can actually place them correctly, touching the actual code they should be touching; also we don't need to perform any of the normal comment management/manipulation code on them, since they are already all in place.
This PR does cause some minor churn around a small handful of docstring comments in our snapshotted files (see the second commit in this PR), but reading through all of them, it seems largely either acceptable, or even welcome changes (e.g., making the docstring associate with the next item, rather than with the previous item).