ci: validate internal doc comments match markdown documentation #32074
+1,266
−1,237
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
Signed-off-by: Petros Angelatos <[email protected]>
Signed-off-by: Petros Angelatos <[email protected]>
Signed-off-by: Petros Angelatos <[email protected]>
petrosagg
force-pushed
the
ci-validate-doc-comments
branch
from
6bce7f8 to
683da24
Compare
ParkMyCar
approved these changes
Apr 2, 2025
antiguru
approved these changes
Apr 2, 2025
| @@ -106,7 +124,8 @@ def main() -> None: | |||
| elif "array" in type_name: | |||
| type_name = "array" | |||
| type_name = type_name.replace(" ", "␠") | |||
| print(" ".join([str(position), field, type_name])) | |||
| documentation = documentation.replace(" ", "␠") | |||
| print(" ".join([field, type_name, documentation])) | |||
| position += 1 | |||
There was a problem hiding this comment.
Probably don't need position anymore?
def-
reviewed
Apr 2, 2025
| field = FIELD_NAME_RE.search(fields[0]).group(1) | ||
| type_name = FIELD_TYPE_RE.search(fields[1]).group(1) | ||
| documentation = DOC_LINK_TYPE1_RE.sub(r"\1", fields[2]) | ||
| documentation = DOC_LINK_TYPE2_RE.sub(r"\1", documentation) |
There was a problem hiding this comment.
Why is documentation being assigned twice? Edit: I guess it makes sense, just doing two substitutions. I would have just nested them.
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.
Motivation
This is a follow up PR from my previous work that will ensure the field documentation we publish in our docs is also reflected as comments in the product. Having it as a CI step will ensure the two will stay in sync.
Tips for reviewer
The last commit is pure code gen and is marked as such
Checklist
$T ⇔ Proto$Tmapping (possibly in a backwards-incompatible way), then it is tagged with aT-protolabel.