clarify that showvalues "name" can be a string #329
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the
README.md
example, it used a symbol for the "name" in theshowvalue
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.)