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

Hide --print-acir from showing in help for commands other than compile #2130

Open
TomAFrench opened this issue Aug 2, 2023 · 5 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@TomAFrench
Copy link
Member

Problem

The --show-ssa, --show-brillig, and --print-acir are not hugely useful for most users of Nargo, mainly for us on the Noir team which need to use them for debugging the Noir compiler itself.

While they should exist, we don't need to document them for end users.

Happy Case

These flags should be hidden from the CLI help output. One exception on this is that we should potentially allow printing ACIR on the nargo info command.

Alternatives Considered

No response

Additional Context

No response

Would you like to submit a PR for this Issue?

Yes

Support Needs

No response

@TomAFrench TomAFrench added enhancement New feature or request P-LOW labels Aug 2, 2023
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Aug 2, 2023
@TomAFrench TomAFrench self-assigned this Aug 2, 2023
@Savio-Sou
Copy link
Collaborator

What's the harm to leaving them as is? Noise?

@TomAFrench
Copy link
Member Author

Yeah, 90% of developers never need to use these flags. I'm also planning on restricting which commands they apply to (they currently apply to prove just because it implicitly compiles Noir code if we don't provide ACIR).

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Aug 8, 2023

Makes sense.

I guess I don't have a strong opinion for this case specifically, but in general we might want to have one "source of truth" (whether it being nargo help, docs, or other places) where people that want to dig deep can count on.

Happy to hear thoughts on if / where would that make sense, if any.

@TomAFrench TomAFrench changed the title Hide "dev flags" --show-ssa, --show-brillig, and --print-acir from showing in CLI help Hide --print-acir from showing in help for commands other than compile Aug 8, 2023
@kobyhallx
Copy link
Contributor

While certain things would be available (but hidden) we can state in documentation that they are there but we believe they're not useful for wider population and therefore we do not think about continuing support for them; they might be exposed in some other ways...

@Savio-Sou
Copy link
Collaborator

@kobyhallx certainly!

Do check the doc needs box on the PR if docs are where the info should live 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 📋 Backlog
Development

No branches or pull requests

4 participants