@@ -61,6 +61,20 @@ Add `[Tags]` to every test case. Use an `iop` tag for interoperability tests, on
Write every documentation step as a standalone line comment inside the test case, immediately before the Robot Framework statement it describes. A comment such as `# Client sends an HTTP GET request to b1` becomes one generated test step. To add details beneath a step, place consecutive comments beginning with `# -` after a normal parent comment. Do not use a `# -` item without a preceding parent comment, and do not rely on comments in setup keywords, keyword implementations, or trailing comments because only full-line comments from the test-case body populate `test_steps`.
When a documentation step refers to a payload that is created, returned, or compared, include the Robot Framework variable containing its path instead of writing the payload description or figure number manually. The variable must be declared in the `*** Variables ***` section and resolve to the relevant payload file. For example:
During statistics generation, `${entity_payload_filename}` in the generated step is replaced with `full-version-of-OffStreetParking1.jsonld`. Only the filename is emitted; the directory path is removed. Do not include explicit figure numbers because the documentation generator infers the corresponding figure from the filename.