Add schema for docstring-format-checker
#5309
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
- Introduce `partial-dfc.json` schema for the `docstring-format-checker` package. - Reference the new schema in `pyproject.json` under `dfc` and `docstring-format-checker`. - Provide detailed properties for configuration options in the schema.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 pull request adds support for validating configuration of the
docstring-format-checkertool inpyproject.tomlby introducing a new JSON schema and integrating it into the overallpyproject.jsonschema. The main focus is on enabling schema validation for both[tool.dfc]and[tool.docstring-format-checker]sections.Schema integration for docstring-format-checker:
partial-dfc.jsonthat defines configuration options for thedocstring-format-checkertool, including properties likeallow_undefined_sections,require_docstrings,check_private,validate_param_types,optional_style, and a detailedsectionsarray for custom docstring section validation.pyproject.jsonto reference the newpartial-dfc.jsonschema under bothdfcanddocstring-format-checkerkeys, allowing users to configure the tool using either[tool.dfc]or[tool.docstring-format-checker]in theirpyproject.toml.