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

clarify that showvalues "name" can be a string #329

Merged
merged 1 commit into from
Aug 4, 2024

Conversation

stevengj
Copy link
Contributor

@stevengj stevengj commented Jul 27, 2024

In the README.md example, it used a symbol for the "name" in the showvalue argument. It seems a lot clearer to use a string in the example — not only are strings less obscure than symbols, they are also more flexible and natural as labels.

Internally, the code calls string(name), so it can be anything.

(Right now, showvalues is only documented in the README … would be nice to have this in a docstring somewhere.)

Copy link

codecov bot commented Jul 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.73%. Comparing base (807496a) to head (721da1a).
Report is 19 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #329      +/-   ##
==========================================
+ Coverage   93.48%   96.73%   +3.25%     
==========================================
  Files           1        1              
  Lines         399      552     +153     
==========================================
+ Hits          373      534     +161     
+ Misses         26       18       -8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MarcMush MarcMush merged commit cf685c3 into timholy:master Aug 4, 2024
26 checks passed
@stevengj stevengj deleted the patch-1 branch August 9, 2024 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants