update most needextend directives to affect only the current file - #759
Conversation
There was a problem hiding this comment.
🟢 Ready to approve
The updates consistently apply an already-established needextend scoping pattern ("c.this_doc()") and the affected directives remain correctly placed/indented in their RST contexts.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
This PR updates multiple needextend directives in the process description RST sources to scope extensions strictly to the current document via c.this_doc(), reducing unintended cross-document effects when documents are embedded or reused.
Changes:
- Replaced
needextendfilters based ondocnamesubstring checks with.. needextend:: "c.this_doc()"across several process area documents. - Kept existing tagging behavior (
:+tags:) while making the selection criteria more robust to embedding / docname shifts.
File summaries
| File | Description |
|---|---|
| process/process_areas/security_management/security_management_workflow.rst | Scope needextend to the current document for security_management tagging. |
| process/process_areas/security_management/index.rst | Scope needextend to the current document for security_management tagging. |
| process/process_areas/security_analysis/index.rst | Scope needextend to the current document for security_analysis tagging. |
| process/process_areas/security_analysis/guidance/security_analysis_process_reqs.rst | Scope needextend to the current document for security_analysis tagging. |
| process/process_areas/safety_management/safety_management_workflow.rst | Scope needextend to the current document for safety_management tagging. |
| process/process_areas/safety_management/index.rst | Scope needextend to the current document for safety_management tagging. |
| process/process_areas/safety_analysis/index.rst | Scope needextend to the current document for safety_analysis tagging. |
| process/process_areas/safety_analysis/guidance/safety_analysis_process_reqs.rst | Scope needextend to the current document for safety_analysis tagging. |
| process/process_areas/quality_management/quality_workflow.rst | Scope needextend to the current document for quality_management tagging. |
| process/process_areas/quality_management/index.rst | Scope needextend to the current document for quality_management tagging. |
| process/process_areas/process_management/process_management_workflow.rst | Scope needextend to the current document for process_management tagging. |
| process/process_areas/process_management/index.rst | Scope needextend to the current document for process_management tagging. |
| process/process_areas/process_management/guidance/process_management_reqs.rst | Scope needextend to the current document for process_management tagging. |
| process/process_areas/problem_resolution/problem_resolution_workflow.rst | Scope needextend to the current document for problem_resolution tagging. |
| process/process_areas/problem_resolution/index.rst | Scope needextend to the current document for problem_resolution tagging. |
| process/process_areas/implementation/index.rst | Scope needextend to the current document for implementation tagging. |
| process/process_areas/implementation/guidance/implementation_process_reqs.rst | Scope needextend to the current document for implementation tagging. |
| process/process_areas/change_management/index.rst | Scope needextend to the current document for change_management tagging. |
| process/process_areas/change_management/guidance/change_management_reqs.rst | Scope needextend to the current document for change_management tagging. |
| process/process_areas/change_management/change_management_workflow.rst | Scope needextend to the current document for change_management tagging. |
Review details
- Files reviewed: 20/20 changed files
- Comments generated: 0
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
|
The created documentation from the pull request is available at: docu-html |
Since docs-as-code is moving towards supporting more fine grained docs-targets and embedding documentations into documentations, we cannot reliably predict cross document behavior of needextend. Sometimes it may affect a different set of needs than other times.
For example when needextend is applied to "x in docname", and someone else embedds process documentation into their module, and for whatever reason they also have "x", then suddenly the needextend will affect more files/needs.
This was already problematic in reference_integration in the past, we just got lucky due to "unique enough" names. But that will not suffice for a broader rollout.
This PR changes about 70% of needextend directives in process_descriptions. Those where the change is a single one-liner.
Verification performed: needs_json generated before the change, change applied, needs_json generated again, no diff.