Open
Conversation
a-zw
requested review from
AlexanderLanin,
MaximilianSoerenPollak,
dcalavrezo-qorix and
nradakovic
as code owners
License Check Results🚀 The license check job ran with the Bazel command: bazel run //src:license-checkStatus: Click to expand output |
Contributor
MaximilianSoerenPollak
left a comment
MaximilianSoerenPollak
left a comment
There was a problem hiding this comment.
Some questions that came to mind.
But overall looks like a good approach. 💯
| **sphinx_options.needs_global_options, | ||
| **app.config.needs_global_options, | ||
| } | ||
| config_setdefault(app.config, "html_theme", html_options.html_theme) |
Contributor
There was a problem hiding this comment.
A bit confused why this is only used here?
Will the unpacking via ** what will happen if keys are already there? Would it not error?
|
|
||
| puml = score_layout_path / "assets" / "puml-theme-score.puml" | ||
| app.config.needs_flow_configs = {"score_config": f"!include {puml}"} | ||
| app.config.needs_flow_configs.setdefault("score_config", f"!include {puml}") |
Contributor
There was a problem hiding this comment.
Is this just .setdefault ? Instead of config_setdefault?
Comment on lines
+54
to
+55
| app.config.source_suffix.setdefault(".rst", "restructuredtext") | ||
| app.config.source_suffix.setdefault(".md", "markdown") |
Contributor
There was a problem hiding this comment.
Also 'setdefault' instead of config_setdefault?
Comment on lines
+57
to
+58
| if "templates" not in app.config.templates_path: | ||
| app.config.templates_path += ["templates"] |
Contributor
There was a problem hiding this comment.
This would then add templates to it even if there are none there or they are somewher else for the user no?
Would it not be better to have it be only set if it's empty?
Comment on lines
+36
to
+46
| def test_config_setdefault_sets_when_not_in_raw_config(): | ||
| cfg = _FakeConfig(raw={}) | ||
| config_setdefault(cfg, "html_copy_source", False) # pyright: ignore [reportArgumentType] | ||
| assert cfg.html_copy_source is False # pyright: ignore [reportAttributeAccessIssue] | ||
|
|
||
|
|
||
| def test_config_setdefault_does_not_overwrite_user_value(): | ||
| cfg = _FakeConfig(raw={"html_copy_source": True}) | ||
| cfg.html_copy_source = True # pyright: ignore[reportAttributeAccessIssue] | ||
| config_setdefault(cfg, "html_copy_source", False) # pyright: ignore [reportArgumentType] | ||
| assert cfg.html_copy_source is True # pyright: ignore[reportAttributeAccessIssue] |
Contributor
There was a problem hiding this comment.
Should we really ignore all of the warnings here?
I guess for tests it isn't as severe as for normal code.
Contributor
|
Also error in the build documentation: |
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
2 participants
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
Don't blindly overwrite user configuration.
Instead set configuration only when not set before.
🚨 Impact Analysis
✅ Checklist