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

Limit inner doc comment attributes to Module #4113

Merged
merged 4 commits into from
Feb 17, 2023
Merged

Conversation

eureka-cpu
Copy link
Contributor

@eureka-cpu eureka-cpu commented Feb 16, 2023

Description

Ran on test branch & working as intended. Only beginning of file //! is collected as DocComment with DocStyle::Inner which is only parsed at the beginning of the Module parsing stage. This ensures that any //! found after the module docs will be treated as normal comments for now. Ref #4112 for tracking further progress in allowing inner doc comments for Item.

Checklist

  • I have linked to any relevant issues. Closes Limit inner doc comment attributes to Module #4097
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@eureka-cpu eureka-cpu added the compiler: parser Everything to do with the parser label Feb 16, 2023
@eureka-cpu eureka-cpu self-assigned this Feb 16, 2023
@eureka-cpu eureka-cpu added the bug Something isn't working label Feb 16, 2023
@eureka-cpu eureka-cpu marked this pull request as ready for review February 16, 2023 20:50
@eureka-cpu eureka-cpu requested review from a team February 16, 2023 20:50
@eureka-cpu eureka-cpu enabled auto-merge (squash) February 16, 2023 20:54
Copy link
Contributor

@mitchmindtree mitchmindtree left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah nice, I think this conservative approach and enforcing some consistency like this is the right one 👍 We can reconsider enabling for all items if someone comes across an actual good use-case to have them anywhere else.

@eureka-cpu eureka-cpu requested review from a team February 17, 2023 04:01
@eureka-cpu eureka-cpu merged commit ceb384b into master Feb 17, 2023
@eureka-cpu eureka-cpu deleted the eureka-cpu/4097 branch February 17, 2023 06:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working compiler: parser Everything to do with the parser
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Limit inner doc comment attributes to Module
3 participants