docs: clarify the args of regexReplaceAll and regexReplaceAllLiteral #1738
Conversation
aabouzaid
force-pushed
the
update-regex-replace-docs
branch
2 times, most recently
from
6d49a80 to
c3ec962
Compare
yxxhero
force-pushed
the
update-regex-replace-docs
branch
from
c3ec962 to
a5b3f01
Compare
| @@ -905,6 +905,10 @@ replacement string replacement. Inside string replacement, $ signs are | |||
| interpreted as in Expand, so for instance $1 represents the text of the first | |||
| submatch | |||
| ``` | |||
There was a problem hiding this comment.
| ``` | |
| ```yaml |
Maybe set format for these examples?
There was a problem hiding this comment.
@TerryHowe Good idea, I'd like to make it, but it's not there in the English version.
Should I make the change to all regex* sections?
There was a problem hiding this comment.
Format type doesn't seem to matter much here as near as I can tell.
I am not a maintainer on this project and I don't know if they want usage for these.
There are PRs on these methods frequently and I don't exactly know why Sprig docs aren't just included or referenced here https://masterminds.github.io/sprig/strings.html
aabouzaid
force-pushed
the
update-regex-replace-docs
branch
from
3395e77 to
eb62ca6
Compare
I did it that way to update all languages, but I can only add the text for English. Here is how it looks after the change (I will remove the changes from other languages if we agree on that) |
| submatch. The first argument is `<pattern>`, second is `<input>`, and third is | ||
| `<replacement>`. |
There was a problem hiding this comment.
I think your PR will have a better chance of merging if you limit it to these two lines and the change on line 922. Try just the english version.
There was a problem hiding this comment.
@TerryHowe Makes sense. I limited the change to that part only.
Thanks for your feedback 🙌
aabouzaid
force-pushed
the
update-regex-replace-docs
branch
from
3fc589e to
19a0eb5
Compare
Signed-off-by: Ahmed AbouZaid <[email protected]>
aabouzaid
force-pushed
the
update-regex-replace-docs
branch
from
19a0eb5 to
7aa48c6
Compare
Hi 👋
I've added a tiny clarification for the
regexReplaceAllandregexReplaceAllLiteralfunctions, as they have an unusual args order (the input is in the middle).That will make the example easier to read.