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

Create plot_extraction.md #9

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Create plot_extraction.md #9

wants to merge 18 commits into from

Conversation

dhiraj-ms
Copy link
Contributor

Describe your changes
A clear and concise description of what changes are made by this pull request.
What was the previous functionality (if relevant) and what can we do now with
these changes.

Type of update
Is this a:

  • Bug fix
  • New feature or feature enhancement
  • Update to documentation
  • Work in progress

Associated issues
Reference associated issue numbers. Does this pull request close any issues?

Additional context
Add any other context about the problem here.

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

deepsource-io bot commented May 28, 2024

Here's the code health analysis summary for commits 61c76c0..300409e. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython❌ Failure
❗ 7 occurences introduced
View Check ↗
DeepSource Test coverage LogoTest coverage❌ Failure
❗ 1 occurence introduced
View Check ↗

Code Coverage Report

MetricAggregatePython
Branch Coverage100%100%
Composite Coverage56.8% (down 43.2% from main)56.8% (down 43.2% from main)
Line Coverage56.8% (down 43.2% from main)56.8% (down 43.2% from main)
New Branch Coverage100%100%
New Composite Coverage0%0%
New Line Coverage0%0%

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@dhiraj-ms dhiraj-ms added the documentation Improvements or additions to documentation label May 28, 2024
@dhiraj-ms dhiraj-ms added Work in Progress and removed documentation Improvements or additions to documentation labels Jun 18, 2024
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is super minor, but having the filename closely matching the function name will make things more searchable as this repository gets larger in the future. Therefore, I suggest changing the filename to "extract_plot.md" here and the function file to "extract_plot.py".

Generally, this PR is adding a few functions all under the aim of plot extraction, but do we only expect an end user to call the function "write_shapefile"? If so, we can consider making the syntax of the other functions similar to that used in "helper functions" in the main namespace (e.g. _calculate_grid is a helper function of auto_grid inside roi_methods.py).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants