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

Misplace doc comments don't give a helpful error message #5989

Closed
asterite opened this issue Sep 10, 2024 · 0 comments · Fixed by #5990
Closed

Misplace doc comments don't give a helpful error message #5989

asterite opened this issue Sep 10, 2024 · 0 comments · Fixed by #5990
Assignees
Labels
bug Something isn't working

Comments

@asterite
Copy link
Collaborator

Aim

This code:

fn main() {
    /// Hello
    let x = 1;

}

Gives this error message:

Unexpected LineComment(" Hello", Some(Outer)), expected one of break, comptime, continue, for, if, {, }, expression, statement, InternedStatement

Expected Behavior

Instead, it should give a more helpful message saying that the doc comment doesn't document anything, and that it should be changed to a regular // comment.

Bug

The error message is not helpful.

To Reproduce

Workaround

None

Workaround Description

No response

Additional Context

No response

Project Impact

None

Blocker Context

No response

Nargo Version

No response

NoirJS Version

No response

Proving Backend Tooling & Version

No response

Would you like to submit a PR for this Issue?

None

Support Needs

No response

@asterite asterite added the bug Something isn't working label Sep 10, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Sep 10, 2024
@asterite asterite self-assigned this Sep 10, 2024
github-merge-queue bot pushed a commit that referenced this issue Sep 10, 2024
# Description

## Problem

Resolves #5989

## Summary

Whenever there's a parsing error and we find a doc comment it means it's
a misplaced doc comment.

## Additional Context


## Documentation

Check one:
- [x] No documentation needed.
- [ ] Documentation included in this PR.
- [ ] **[For Experimental Features]** Documentation to be submitted in a
separate PR.

# PR Checklist

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Noir Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant