-
Couldn't load subscription status.
- Fork 1
👌Remove the need item for src-trace #39
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.
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
Conversation
- updated TCs - updated docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR removes the automatic creation of "srctrace" type need items by the src-trace directive, addressing issues #15 and #38. The directive now focuses solely on extracting and rendering need items from source code without creating its own need item.
- Removed the requirement for title argument and id option in the
src-tracedirective - Eliminated the creation of "srctrace" type need items that were automatically generated
- Updated documentation and test files to reflect the new simplified directive usage
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/sphinx_codelinks/sphinx_extension/directives/src_trace.py | Removed need creation logic, title requirement, and ID handling functions |
| tests/doc_test/*/index.rst | Updated directive usage to remove title arguments |
| tests/data/sphinx/index.rst | Updated directive usage to remove title arguments |
| tests/snapshots/test_src_trace/*.doctree.xml | Removed expected "srctrace" need items from test snapshots |
| docs/source/development/change_log.rst | Added changelog entry documenting the behavior change |
| docs/source/components/directive.rst | Updated directive examples to remove title and id requirements |
| docs/source/basics/quickstart.rst | Updated quickstart example to remove title argument |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Marco Heinemann <[email protected]>
Co-authored-by: Marco Heinemann <[email protected]>
Co-authored-by: Marco Heinemann <[email protected]>
Co-authored-by: Marco Heinemann <[email protected]>
Co-authored-by: Marco Heinemann <[email protected]>
Issue
#15
#38
TLDR
Removed the need item created and typed by the directive
src-trace.Details
Directive
src-tracecreates the need item typed bysrctraceand it doesn't have any use cases so far. Instead, it draws conflicts with the Sphinx-Needs configuration. For example, ifneeds_id_reqiredorneeds_statusesis enabled, the error occurs when generating thesrctraceneed item. In order to fix it, the extra need item generated bysrc-traceis removed.