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

Docs: Describe Derivation of Constraints; Don't Present Them #273

Open
aszepieniec opened this issue Apr 30, 2024 · 0 comments
Open

Docs: Describe Derivation of Constraints; Don't Present Them #273

aszepieniec opened this issue Apr 30, 2024 · 0 comments
Labels
💫 good first issue Good for newcomers 📜 specification Relates to the specification

Comments

@aszepieniec
Copy link
Collaborator

Currently, the AIR constraints documentation is difficult to read and even more difficult to maintain. The constraints, as presented, are not informative. We should not be presenting the them but rather describing where they came from and how to (re-)derive them.

Note that someone who is unfamiliar with our codebase might be a little confused about how a description maps onto a constraint. So we need an additional section explaining how to derive a concrete set of constraints from a textual description of what they are supposed to do.

@aszepieniec aszepieniec added 📜 specification Relates to the specification 💫 good first issue Good for newcomers labels Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💫 good first issue Good for newcomers 📜 specification Relates to the specification
Projects
None yet
Development

No branches or pull requests

1 participant