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

Change constrain key word to assert #384

Closed
kevaundray opened this issue Oct 20, 2022 · 3 comments · Fixed by #1227
Closed

Change constrain key word to assert #384

kevaundray opened this issue Oct 20, 2022 · 3 comments · Fixed by #1227
Labels

Comments

@kevaundray
Copy link
Contributor

No description provided.

@kevaundray
Copy link
Contributor Author

If we are going to do this change, it should be sooner rather than later.

My suggestion is to allow constrain and assert for about a year, but change all documentation to use assert.

This way existing programs are not broken and newer programs are discouraged from using it. A lint would also be good here, to notify existing programs that it is being phased out.

Cc @jfecher @guipublic @vezenovm

@jfecher
Copy link
Contributor

jfecher commented Jan 23, 2023

I am fine with constrain or assert. The later would be more familiar to those coming from other languages, but perhaps constrain is clearer for those already in the ZKPL space?

The change is fairly trivial to make if we do want to change to assert. I'll also suggest we can issue a deprecation warning for constrain while in this intermediate period of allowing both.

@kevaundray
Copy link
Contributor Author

pinging @sirasistant for visibility

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

Successfully merging a pull request may close this issue.

3 participants