noir-lang / noir

Noir is a domain specific language for zero knowledge proofs
https://noir-lang.org
Apache License 2.0
874 stars 189 forks source link

Investigate Results for CrateGraph public-ish APIs #2407

Open phated opened 1 year ago

phated commented 1 year ago

Problem

From https://github.com/noir-lang/noir/pull/2391#issuecomment-1688687666

RE, Results versus panicking, I think we can create another issue to return results here and panic further up the stack or possibly not panic and keep bubbling it up the stack -- We were already panicking which is why I think its okay to leave that for another PR

We should determine if we consider some CrateGraph functions to be public and, if so, decide if they should return results.

Happy Case

Public APIs should not panic, even if we still panic further up the stack while consuming the APIs.

Alternatives Considered

No response

Additional Context

No response

Would you like to submit a PR for this Issue?

No

Support Needs

No response

Savio-Sou commented 11 months ago

Assigning P-MEDIUM as it sounds like something that would help ease debugging in general.

Guessing E-MEDIUM.