[DOCS] Clear pydocstyle errors in codegen and pyspark - #582
Merged
Conversation
`make docformat` (pydocstyle, numpy convention) flagged eight docstrings across overture-schema-codegen and overture-schema-pyspark: - D301 (raw string for backslashes): `_bare_map_side_name`, `normalize_anchor`, and `check_pattern` move to `r"""` and drop the doubled backslashes, so the rendered text is unchanged. - D401 (imperative mood): `_condition_value` and `absent_column` reword the summary to lead with a verb. - D401 on `check_string_min_length` / `check_string_max_length`: pydocstyle's stemmer trips on a leading "String", so the summary now reads "Minimum/Maximum character length check for strings", matching the sibling `check_array_*` docstrings. - D403 on `map_runtime_helper`: the check lowercases the proper noun "PySpark" to "Pyspark", so the summary is reworded to keep PySpark out of first position. Docstring text only, no behavior change. Refs #581 Signed-off-by: Seth Fitzsimmons <seth@mojodna.net>
🗺️ Schema reference docs preview is live!
Note ♻️ This preview updates automatically with each push to this PR. |
TristanDiet-TomTom
approved these changes
Jul 22, 2026
Victor Schappert (vcschapp)
approved these changes
Jul 22, 2026
Victor Schappert (vcschapp)
added
change type - cosmetic 🌹
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
3 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.
Summary
make docformat(pydocstyle, numpy convention) flagged eight docstrings acrossoverture-schema-codegenandoverture-schema-pyspark. This clears all of them. Docstring text only, no runtime behavior change.Fixes
_bare_map_side_name,normalize_anchor,check_pattern: switch tor"""and drop the doubled backslashes so the rendered text (\|,\z,\d \s \w \S) is unchanged._condition_value,absent_column: reword the summary to lead with a verb.check_string_min_length/check_string_max_length— pydocstyle's stemmer trips on a leading "String"; the summaries now read "Minimum/Maximum character length check for strings", parallel to the siblingcheck_array_*docstrings.map_runtime_helper— the check lowercases the proper noun "PySpark" to "Pyspark"; reworded so PySpark is no longer the first word.Scope
Limited to the two named packages. Other packages (annex, common, system, transportation-theme) have separate missing-docstring errors (D100/D101) not addressed here.
Closes #581