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

affine_color_correct docs - code example calling wrong function #1533

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

Conversation

HaleySchuhl
Copy link
Contributor

Describe your changes
Making affine cc docs more accurate plus adding links to relevant functions

Type of update
Is this a:

  • Bug fix
  • Update to documentation
    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

@HaleySchuhl HaleySchuhl added documentation Documentation issues or features bugfix Bug fixes labels May 17, 2024
Copy link

deepsource-io bot commented May 17, 2024

Here's the code health analysis summary for commits 5bc5535..80706f9. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython✅ SuccessView Check ↗
DeepSource Test coverage LogoTest coverage✅ SuccessView Check ↗

Code Coverage Report

MetricAggregatePython
Branch Coverage100%100%
Composite Coverage99.7%99.7%
Line Coverage99.7%99.7%

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

@@ -13,7 +13,7 @@ Euclidean distance between the transformed source color values and the target co

- **Parameters:**
- rgb_img - an RGB image with color chips visualized
- source_matrix - array of RGB color values (intensity in the range [0-1]) from the image to be corrected where each row is one color reference and the columns are organized as index,R,G,B
- source_matrix - array of RGB color values (intensity in the range [0-1]) from the image to be corrected where each row is one color reference and the columns are organized as index,R,G,B (likely created with [plantcv.transform.create_color_card_mask](create_color_card_mask.md) or [plantcv.transform.detect_color_card](transform_detect_color_card.md)).
Copy link
Member

Choose a reason for hiding this comment

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

source_matrix is from pcv.transform.get_color_matrix, using a color card mask

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ought to be accurate now I think

Copy link
Member

@nfahlgren nfahlgren left a comment

Choose a reason for hiding this comment

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

See comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Bug fixes documentation Documentation issues or features ready to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants