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

feat: Add multi-line comments #1936

Merged
merged 1 commit into from Jul 17, 2023
Merged

feat: Add multi-line comments #1936

merged 1 commit into from Jul 17, 2023

Conversation

ghost
Copy link

@ghost ghost commented Jul 15, 2023

Description

support for multi-line comments: https://doc.rust-lang.org/reference/comments.html

PR Checklist

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

Sorry, something went wrong.

@kevaundray kevaundray enabled auto-merge July 17, 2023 22:46
@kevaundray kevaundray changed the title chore: lex block comments feat: Add multi-line comments Jul 17, 2023
@kevaundray kevaundray added this pull request to the merge queue Jul 17, 2023
@kevaundray
Copy link
Contributor

@Savio-Sou or @signorecello pinging for visibility

Merged via the queue into noir-lang:master with commit cfb1765 Jul 17, 2023
@ghost ghost deleted the block_comments branch July 18, 2023 09:23
@ghost ghost mentioned this pull request Jul 18, 2023
2 tasks
@critesjosh
Copy link
Contributor

critesjosh commented Jul 18, 2023

@f01dab1e follow up question for documentation purposes. In the link to the Rust docs in the PR description, there is no comment labelled "multi-line". Does this PR only add support for BLOCK_COMMENTs that start with /* and end with */?

Would it be accurate to say "You can use Rust doc comments in your code to leverage Rust doc build tools for Noir code." ?

@ghost
Copy link
Author

ghost commented Jul 18, 2023

yes, I use block comments to indicate multi-line comments. 'doc comments' can be misleading because Noir does not actually support doc comments. while using them will not result in an error, they will simply be ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants