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

Fix/improve various dosctrings #1903

Merged
merged 2 commits into from Sep 7, 2023
Merged

Fix/improve various dosctrings #1903

merged 2 commits into from Sep 7, 2023

Conversation

AdeelH
Copy link
Collaborator

@AdeelH AdeelH commented Sep 7, 2023

Overview

This PR fixes/improves various dosctrings throughout the code base. Most of the fixes are for the formatting of the return value description.

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

N/A

Testing Instructions

  • See CI docs build.

@codecov
Copy link

codecov bot commented Sep 7, 2023

Codecov Report

Merging #1903 (4b1192e) into master (0ebb906) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 4b1192e differs from pull request most recent head 7a0edbb. Consider uploading reports for the commit 7a0edbb to get more accurate results

@@           Coverage Diff           @@
##           master    #1903   +/-   ##
=======================================
  Coverage   81.56%   81.56%           
=======================================
  Files         190      190           
  Lines        9282     9282           
=======================================
  Hits         7571     7571           
  Misses       1711     1711           
Files Changed Coverage Δ
rastervision_core/rastervision/core/box.py 100.00% <ø> (ø)
...vision_core/rastervision/core/data/label/labels.py 100.00% <ø> (ø)
...on/core/data/label/semantic_segmentation_labels.py 91.53% <ø> (ø)
...astervision/core/data/label_source/label_source.py 75.00% <ø> (ø)
...data/label_source/object_detection_label_source.py 83.63% <ø> (ø)
...vision_core/rastervision/core/data/utils/raster.py 97.05% <ø> (ø)
...ision/core/evaluation/classification_evaluation.py 96.87% <ø> (ø)
...vision_core/rastervision/core/rv_pipeline/utils.py 100.00% <ø> (ø)
rastervision_core/rastervision/core/utils/stac.py 70.58% <ø> (ø)
...tervision_pipeline/rastervision/pipeline/config.py 79.59% <ø> (ø)
... and 6 more

📢 Have feedback on the report? Share it here.

@AdeelH AdeelH marked this pull request as ready for review September 7, 2023 18:30
@AdeelH AdeelH merged commit 9be1f2e into azavea:master Sep 7, 2023
1 check passed
@AdeelH AdeelH added the needs-backport This PR needs to be backported to release branches label Sep 7, 2023
@AdeelH AdeelH deleted the docstr branch September 7, 2023 18:46
AdeelH added a commit to AdeelH/raster-vision that referenced this pull request Sep 7, 2023
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.

None yet

1 participant