♻️ Refactor need data post-processing #1018
Closed
Conversation
This file contains 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
chrisjsewell
added a commit
that referenced
this pull request
Sep 11, 2023
Previously, the validity of needs data was tested by asserting for only specific keys and values. This PR adds snapshot testing, with https://github.com/tophat/syrupy, to more fully capture the generated data. This should help to better identify any regressions caused by future changes (such as #1018).
This was referenced Sep 26, 2023
|
Closing as superceded by #1054 |
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.
This PR moves the post-processing of needs data into a single event, which takes place before the write phase of Sphinx
In principle, this means that
needsbuilders can bypass the entire write phase of the sphinx build.However, there are currently two issues:
export_idis set on a directive, this requires filter data to also be output in theneeds.jsondata, and this is only computed in the write stageneedextract)needsumlbuilder, the data is only added inprocess_needuml