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.

Sign up for GitHub

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

Jump to bottom

[Feature Request] Provide an option to make mojo doc fail if any warnings are triggered #2447

Closed
1 task done
gabrieldemarmiesse opened this issue Apr 29, 2024 · 1 comment
Closed
1 task done

[Feature Request] Provide an option to make mojo doc fail if any warnings are triggered #2447

gabrieldemarmiesse opened this issue Apr 29, 2024 · 1 comment
Assignees
@River707
Labels
enhancement New feature or request Initiative: Documentation mojo-repo Tag all issues with this label mojo-tooling Tag for all issues related to repl, lldb, lsp, vscode extension.

Comments

@gabrieldemarmiesse
Copy link
Contributor

gabrieldemarmiesse commented Apr 29, 2024 •
edited

Review Mojo's priorities

What is your request?

We would like to use this option in the CI to ensure every docstring has the appropriate fields. We can do this by checking the stderr manually, but this does not seem very future-proof if something else than warnings are one day written to stderr.

What is your motivation for this change?

See @JoeLoser 's comment here also: #2344 (comment)

Any other details?

See this PR: #2444 where we have to manually parse stderr
@gabrieldemarmiesse gabrieldemarmiesse added enhancement New feature or request mojo-repo Tag all issues with this label labels Apr 29, 2024
@gabrieldemarmiesse gabrieldemarmiesse mentioned this issue Apr 29, 2024
Closed
@JoeLoser JoeLoser added the mojo-tooling Tag for all issues related to repl, lldb, lsp, vscode extension. label Apr 29, 2024
@JoeLoser
Copy link
Collaborator

FYI @modocache @River707

@River707 River707 self-assigned this May 4, 2024
@River707 River707 closed this as completed May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@River707 River707

Labels
enhancement New feature or request Initiative: Documentation mojo-repo Tag all issues with this label mojo-tooling Tag for all issues related to repl, lldb, lsp, vscode extension.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@JoeLoser @gabrieldemarmiesse @River707