Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docstrings for most commonly used classes and configs #1630

Merged
merged 4 commits into from
Dec 28, 2022

Conversation

AdeelH
Copy link
Collaborator

@AdeelH AdeelH commented Dec 28, 2022

Overview

This PR improves the docstrings for the most commonly used classes and configs. Most config docstrings now have a link to their corresponding non-config class.

Checklist

  • Added needs-backport label if PR is bug fix that applies to previous minor release
  • Ran scripts/format_code and committed any changes
  • Documentation updated if needed
  • PR has a name that won't get you publicly shamed for vagueness

Notes

While working on this PR, I learned that

:some_domain:`~full.path.to.SomeObject`

can be shortened to

:some_domain:`.SomeObject`

This made adding cross-reference to docstrings a lot cleaner.

Testing Instructions

Check if the build docs look fine.

Part of #1505

@AdeelH AdeelH added the needs-backport This PR needs to be backported to release branches label Dec 28, 2022
@AdeelH AdeelH mentioned this pull request Dec 28, 2022
15 tasks
@codecov
Copy link

codecov bot commented Dec 28, 2022

Codecov Report

Merging #1630 (e928479) into master (50b7292) will decrease coverage by 0.04%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##           master    #1630      +/-   ##
==========================================
- Coverage   75.71%   75.66%   -0.05%     
==========================================
  Files         192      192              
  Lines        9260     9254       -6     
==========================================
- Hits         7011     7002       -9     
- Misses       2249     2252       +3     
Impacted Files Coverage Δ
...core/rastervision/core/analyzer/analyzer_config.py 70.00% <ø> (ø)
..._core/rastervision/core/analyzer/stats_analyzer.py 94.11% <ø> (ø)
...astervision/core/analyzer/stats_analyzer_config.py 75.00% <ø> (ø)
...n_core/rastervision/core/backend/backend_config.py 66.66% <ø> (ø)
rastervision_core/rastervision/core/box.py 92.41% <ø> (ø)
...vision_core/rastervision/core/data/class_config.py 92.18% <ø> (ø)
...ision/core/data/crs_transformer/crs_transformer.py 71.26% <ø> (ø)
...sion_core/rastervision/core/data/dataset_config.py 80.70% <ø> (ø)
..._source/chip_classification_label_source_config.py 87.75% <ø> (ø)
...sion/core/data/label_source/label_source_config.py 85.71% <ø> (ø)
... and 64 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-backport This PR needs to be backported to release branches
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant