TF004 Add comments¶
Write a comment file to add comments to requirements
Is a test for
Initial state¶
The expected state is the final state of
TF002 Generate a PDF
Procedure¶
Step 1¶
Create a comment file
$ cat comments.yaml
kind: comments
comments:
- about: S01
from: Some Person
date: 01/01/2025
text: The first comment
Step 2¶
Add it to the typst source
$ cat specification.typ
#import "@local/speky:0.0.7": speky
#speky(("spec.yaml", "tests.yaml", "comments.yaml").map(yaml))
Step 3¶
Regenerate the PDF and open it
$ typst compile specification.typ && open specification.typ
Step 4¶
Verify the comment appears in requirement S01, in the “Comments” subsection.
Comments¶
Can I leave comments on tests too
Yes