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

Consistent formatting for a requirement #5

Open
seebees opened this issue Jun 11, 2021 · 0 comments
Open

Consistent formatting for a requirement #5

seebees opened this issue Jun 11, 2021 · 0 comments

Comments

@seebees
Copy link
Contributor

seebees commented Jun 11, 2021

When extracting the requirement from the specification,
the annotation takes this exact formatting.
This is sub-optimal for two reasons.
First, if the specification changes slightly,
but this requirement remains exactly the same
the code still needs to be updated.
Second, when reading the source
reformatting the specification text makes for easier reading.
e.g. Something like this:

//=master_key_spec.txt#2.1
//# If
//# the key bytes length is
//# over 32 bytes
//# the function MUST fail

would change to

//=master_key_spec.txt#2.1
//# If the key bytes length is over 32 bytes the function MUST fail

Wrap on 80 characters or something.
Any kind of formatting that is deterministic.

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

No branches or pull requests

1 participant