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

Add instructions for updating test_display images in CONTRIBUTING.md #1520

Merged
merged 1 commit into from Jul 1, 2022

Conversation

kianelbo
Copy link
Contributor

@kianelbo kianelbo commented Jul 1, 2022

Reference Issue

Fixes #1502

What does this implement/fix? Explain your changes.

Explains how to add or update baseline images used in tests.

Any other comments?

Is there anything to do other than copying the steps to CONTRIBUTING.md? :))

@bmcfee bmcfee added the documentation Issues relating to docstrings, examples, and documentation build label Jul 1, 2022
@bmcfee bmcfee added this to the 0.10.0 milestone Jul 1, 2022
@bmcfee
Copy link
Member

bmcfee commented Jul 1, 2022

Thanks for this one! All looks good to me.

BTW in the future if you're only updating static docs and not code, you can add [ci skip] to the commit message to bypass the unit tests: https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/

@codecov
Copy link

codecov bot commented Jul 1, 2022

Codecov Report

Merging #1520 (fcacdb9) into main (b9830b4) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1520   +/-   ##
=======================================
  Coverage   98.77%   98.77%           
=======================================
  Files          32       32           
  Lines        4151     4159    +8     
=======================================
+ Hits         4100     4108    +8     
  Misses         51       51           
Flag Coverage Δ
unittests 98.77% <ø> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
librosa/display.py 97.00% <0.00%> (+0.06%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b9830b4...fcacdb9. Read the comment docs.

Copy link
Member

@bmcfee bmcfee left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@bmcfee bmcfee merged commit e55f85a into librosa:main Jul 1, 2022
@kianelbo kianelbo deleted the contrib-test-images branch July 1, 2022 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues relating to docstrings, examples, and documentation build
Development

Successfully merging this pull request may close these issues.

Expand contributor documentation around testing
2 participants