Skip to content

Create Config docstrings from Field descriptions#137

Merged
gpauloski merged 3 commits intomainfrom
issue-120
Aug 23, 2024
Merged

Create Config docstrings from Field descriptions#137
gpauloski merged 3 commits intomainfrom
issue-120

Conversation

@gpauloski
Copy link
Copy Markdown
Contributor

Description

This changes the docs to use griffe-fieldz to automatically inject the field descriptions of BaseModels into the docstring information. This means that field descriptions do not need to be duplicated.

Note that the plugin did not work well with dataclasses so I changed the types of the dataclasses in taps.engine.task.

Fixes

Type of Change

  • Bug (non-breaking change which fixes an issue)
  • Enhancement (non-breaking change which adds or improves functionality)
  • Internal (refactoring, performance, and testing)
  • Breaking (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (no changes to the code)
  • Development (CI workflows, packages, templates, etc.)
  • Package (package dependencies and versions)

Testing

Documentation correctly populates parameters of Configs.

Pull Request Checklist

Please confirm the PR meets the following requirements.

  • Relevant tags are added (breaking, bug, documentation, enhancement, package, etc.).
  • Code changes pass pre-commit (e.g., ruff, mypy, etc.).
  • Tests have been added to show the fix is effective or that the new feature works.
  • New and existing unit tests pass locally with the changes.
  • Docs have been updated and reviewed if relevant.

@gpauloski gpauloski added documentation Improvements or additions to documentation internal Refactoring, style changes, testing, or code optimizations labels Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation internal Refactoring, style changes, testing, or code optimizations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Many Config types are missing docstrings for the "attributes"

1 participant