docs: update implementation status for 7 already-implemented tool requirements#619
Closed
FScholPer wants to merge 2 commits into
Closed
docs: update implementation status for 7 already-implemented tool requirements#619FScholPer wants to merge 2 commits into
FScholPer wants to merge 2 commits into
Conversation
Update implementation status from NO/PARTIAL to YES for tool requirements that are already enforced in code (metamodel.yaml + check_options.py): - tool_req__docs_saf_attrs_content: content mandatory_options on all safety types - tool_req__docs_saf_attrs_violates: violates mandatory_links on all safety types - tool_req__docs_saf_attr_fmea_fault_id: fault_id mandatory_options on FMEA types - tool_req__docs_saf_attr_dfa_failure_id: failure_id mandatory_options on DFA types - tool_req__docs_req_attr_validity_correctness: regex validation in metamodel.yaml - tool_req__docs_req_attr_validity_consistency: check_validity_consistency local check - tool_req__docs_doc_generic_mandatory: all attrs enforced as mandatory_options/links Each updated requirement now includes a :source_code_link: to the corresponding implementation file and an Implementation note. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //src:license-checkStatus: Click to expand output |
Update :source_code_link: fields to point to specific line numbers in metamodel.yaml and check_options.py. Add inline RST hyperlinks in implementation notes so readers can click through to the exact code. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
|
The created documentation from the pull request is available at: docu-html |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📌 Description
Updates
docs/internals/requirements/requirements.rstto reflect that 7 tool requirements previously marked asNOorPARTIALare already enforced in the codebase. Each updated requirement now links to the corresponding implementation file.Requirements updated (NO/PARTIAL → YES):
tool_req__docs_saf_attrs_contentmetamodel.yaml—content: ^[\s\S]+$asmandatory_optionstool_req__docs_saf_attrs_violatesviolateslink to architecture diagramsmetamodel.yaml—mandatory_linkson all safety typestool_req__docs_saf_attr_fmea_fault_idfault_idon FMEA needsmetamodel.yaml—mandatory_optionsonfeat_saf_fmea,comp_saf_fmeatool_req__docs_saf_attr_dfa_failure_idfailure_idon DFA needsmetamodel.yaml—mandatory_optionsonfeat_saf_dfa,comp_saf_dfatool_req__docs_req_attr_validity_correctnessmetamodel.yaml—optional_optionsregex onstkh_req,feat_reqtool_req__docs_req_attr_validity_consistencyvalid_from < valid_untilcheck_options.py—check_validity_consistencylocal checktool_req__docs_doc_generic_mandatorymetamodel.yaml—mandatory_options+mandatory_linksondocumenttypeMotivation
The requirements documentation was outdated — these checks have been implemented in
metamodel.yamlandcheck_options.pybut the:implemented:field was never updated. This reduces the apparent open-issue count by ~37% (from 35 to ~22 real gaps).🚨 Impact Analysis
✅ Checklist