[NEED HELP] Improve codebase documentation to 75% #232
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
nateinaction
added
good first issue
There was a problem hiding this comment.
Pull Request Overview
This PR aims to improve the codebase’s documentation coverage to 75% by introducing tooling checks and updates.
- Added a new [tool.interrogate] section in pyproject.toml to enforce the documentation coverage threshold.
- Updated the pre-commit configuration to run the interrogate hook during linting.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pyproject.toml | Introduces documentation coverage settings via the [tool.interrogate] configuration. |
| .pre-commit-config.yaml | Configures the interrogate hook to run as part of the pre-commit process. |
Comments suppressed due to low confidence (2)
pyproject.toml:80
- The documentation coverage threshold is now set to 75. Please ensure that the current test suite and documentation updates provide sufficient coverage to meet this limit.
fail-under = 75
.pre-commit-config.yaml:26
- [nitpick] Consider explicitly defining the relative or absolute path for the configuration file to ensure consistent behavior across different development environments.
args: [--config=pyproject.toml]
|
|
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.
Story
As a university lab testing building a PROVESKIT for the first time
I want to be able to understand how to write software that interacts with PySquared
So that I can build and launch a satellite in less than a year
Summary
Documentation is a key ingredient in developing an accessible educational satellite platform. Take over this PR and help us reach 75% documentation coverage for our codebase.
How was this tested