♻️ Refactor needs post-processing function signatures #1040
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
changed the title
chrisjsewell
commented
Sep 28, 2023
Comment on lines
+386
to
+391
| resolve_dynamic_values(needs, app) | ||
| resolve_variants_options(needs, needs_config, app.builder.tags.tags) | ||
| check_links(needs, needs_config) | ||
| create_back_links(needs, needs_config) | ||
| process_constraints(needs, needs_config) | ||
| extend_needs_data(needs, needs_data.get_or_create_extends(), needs_config) |
There was a problem hiding this comment.
This is the key change
danwos
approved these changes
Sep 29, 2023
iSOLveIT
pushed a commit
that referenced
this pull request
Oct 24, 2023
This commit refactors the functions that post-process needs data, to only get passed what they actually require (rather than just `app` or `env`). This makes it clearer what they are doing, and in all cases except `resolve_dynamic_values` effectively de-couples the post-processing from Sphinx, since you just need to pass them the needs data and needs configuration.
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 refactors the functions that post-process needs data, to only get passed what they actually require (rather than just
apporenv).This makes it clearer what they are doing, and in all cases except
resolve_dynamic_valueseffectively de-couples the post-processing from Sphinx, since you just need to pass them the needs data and needs configuration.