docs: document array parameter support in std.stripChars/lstripChars/rstripChars#1326
Open
He-Pin wants to merge 1 commit into
Open
docs: document array parameter support in std.stripChars/lstripChars/rstripChars#1326He-Pin wants to merge 1 commit into
He-Pin wants to merge 1 commit into
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
bba70aa to
698bee2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
std.stripChars,std.lstripChars, andstd.rstripCharsaccept an array of single-character strings as thecharsparameterMotivation
The reference implementation in
stdlib/std.jsonnetinherently supports arrays because it usesstd.member(chars, str[0]), which works with both strings and arrays. This behavior is consistent across all major implementations (cpp-jsonnet, go-jsonnet, sjsonnet, jrsonnet) but is not documented.When
charsis an array:Modification
Added a paragraph and example to each of the three function documentation sections in
doc/ref/stdlib.html:std.stripCharsstd.lstripCharsstd.rstripCharsResult
Users can now discover and rely on the array parameter behavior, which is already supported by all implementations.
Cross-implementation verification
std.stripChars("abcba", ["a", "c"])"bcb""bcb""bcb""bcb"std.lstripChars("abcba", ["a", "c"])"bcba""bcba""bcba""bcba"std.rstripChars("abcba", ["a", "c"])"abcb""abcb""abcb""abcb"Closes #1325