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

changing doc string conventions for deepsource best practices #1391

Merged
merged 4 commits into from
Nov 13, 2023
Merged

Conversation

joshqsumner
Copy link
Contributor

@joshqsumner joshqsumner commented Nov 13, 2023

Describe your changes
Changed doc string conventions to align with best practices based on deepsource

Type of update
Is this an update to documentation

For the reviewer
See this page for instructions on how to review the pull request.

  • PR functionality reviewed in a Jupyter Notebook
  • All tests pass
  • Test coverage remains 100%
  • Documentation tested
  • New documentation pages added to plantcv/mkdocs.yml
  • Changes to function input/output signatures added to updating.md
  • Code reviewed
  • PR approved

Copy link

codecov bot commented Nov 13, 2023

Codecov Report

Merging #1391 (3be0ece) into main (996cd11) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##              main     #1391   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          158       158           
  Lines         6939      6939           
=========================================
  Hits          6939      6939           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
plantcv/plantcv/classes.py 100.00% <ø> (ø)
plantcv/plantcv/hyperspectral/write_data.py 100.00% <ø> (ø)
plantcv/plantcv/roi/roi_methods.py 100.00% <ø> (ø)
plantcv/plantcv/segment_image_series.py 100.00% <ø> (ø)
plantcv/plantcv/threshold/threshold_methods.py 100.00% <ø> (ø)

@nfahlgren nfahlgren added ready to review cleanup Code quality updates labels Nov 13, 2023
@nfahlgren nfahlgren merged commit 66708e7 into main Nov 13, 2023
6 checks passed
@nfahlgren nfahlgren deleted the flk-d202 branch November 13, 2023 22:36
@nfahlgren nfahlgren added this to Pull Requests in PlantCV4 via automation Nov 14, 2023
@nfahlgren nfahlgren added this to the PlantCV v4.1 milestone Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Code quality updates ready to review
Projects
PlantCV4
  
Pull Requests
Development

Successfully merging this pull request may close these issues.

None yet

2 participants