Skip to content

fix: mark gd_req__doc_attr_status satisfied #569

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.

Sign up for GitHub

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

Open
a-zw wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −4
Open

fix: mark gd_req__doc_attr_status satisfied #569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/internals/requirements/requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,15 +304,16 @@ Versioning
:id: tool_req__docs_doc_generic_mandatory
:tags: Documents
:implemented: PARTIAL
:version: 1
:version: 2
:satisfies:
gd_req__doc_attributes_manual,
gd_req__change_attr_impact_safety
gd_req__change_attr_impact_safety,
gd_req__doc_attr_status,
:parent_covered: YES

Docs-as-Code shall enforce that each Generic Document ``doc__*`` has the following attributes:
Enforce that each Generic Document ``doc__*`` has the following attributes:
Copy link
Copy Markdown
Contributor

@MaximilianSoerenPollak MaximilianSoerenPollak May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-as-code needs to stay here, as we need an actor in the description.

Copy link
Copy Markdown
Contributor Author

@a-zw a-zw May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there some styleguide on this? We should then undo the other three of these changes in that case.

I find it rather annoying because this is rather clear implicitly for all the requirements here.


* status
* status (one of: valid, draft, invalid)
* security
* safety
* realizes
Expand Down
19 changes: 19 additions & 0 deletions src/extensions/score_metamodel/tests/rst/options/test_options_options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,25 @@
:safety: ASIL_B


.. Tests if the attribute `status` follows the pattern `^(valid|draft|invalid)$`
#EXPECT-NOT[+2]: does not follow pattern

.. document:: This is a test document
:id: doc__test_good_3
:status: draft
:safety: QM


#EXPECT[+4]: doc__test_bad_status_1.status (active): does not follow pattern `^(valid|draft|invalid)$`.
#EXPECT[+3]: doc__test_bad_status_1: is missing required attribute: `security`.
#EXPECT[+2]: doc__test_bad_status_1: is missing required link: `realizes`.

.. document:: This is a test document
:id: doc__test_bad_status_1
:status: active
:safety: QM


#EXPECT-NOT[+2]: does not follow pattern

.. stkh_req:: This is a test
Expand Down
Loading