Add the BuildMetadata class
#299
Open
Conversation
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
hugovk
reviewed
Apr 17, 2025
Comment on lines
+306
to
+307
| _ver: Version | ||
| _lang: Language |
There was a problem hiding this comment.
Let's use full names:
Suggested change
| _ver: Version | |
| _lang: Language | |
| _version: Version | |
| _language: Language |
Comment on lines
+1182
to
+1184
| BuildMetadata(_ver=ver, _lang=lang) | ||
| for ver in versions.filter(args.branches) | ||
| for lang in reversed(languages.filter(args.languages)) |
There was a problem hiding this comment.
Suggested change
| BuildMetadata(_ver=ver, _lang=lang) | |
| for ver in versions.filter(args.branches) | |
| for lang in reversed(languages.filter(args.languages)) | |
| BuildMetadata(_version=version, _language=language) | |
| for version in versions.filter(args.branches) | |
| for language in reversed(languages.filter(args.languages)) |
| @@ -1141,28 +1198,25 @@ def build_docs(args: argparse.Namespace) -> int: | |||
| args.build_root / _checkout_name(args.select_output), | |||
| ) | |||
| while todo: | |||
| version, language = todo.pop() | |||
| b = todo.pop() | |||
There was a problem hiding this comment.
Suggested change
| b = todo.pop() | |
| build_metadata = todo.pop() |
or
Suggested change
| b = todo.pop() | |
| build = todo.pop() |
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.
In the inner loop, we operate on version-language pairs. These are currently only joined in the type system via tuples, or not at all. By introducing the
BuildMetadataclass, we make the link explicit.My intent is to (later) add further attributes to
BuildMetadata(e.g. the directory paths), makingBuildMetadataa data-only class that performs no actions, withDocBuilderperforming the actual build. For example,DocBuilder.html_onlycould be fully merged intoBuildMetadata.A