awslabs/duvet

Consistent formatting for a requirement

Opened this issue · 0 comments

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.