str_replace: add link to rust doc #1584
Closed
Conversation
This file contains 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
Trying to escape a capture group names, I had to discover rust doc. Adding a link to it will bring knowledge :+1: Knowledge! :thinking: Should we copy rust doc here in order to not be coupled with it? I have the feeling nushell<>rust coupling is intentional, this is why I am opening the PR this way
|
unfortunately, command docs cannot be updated this way because they will get overwritten at the next release. For help or examples on commands to be updated, one has to change the rust code. Also, str replace uses |
fdncred
pushed a commit
to nushell/nushell
that referenced
this pull request
Oct 9, 2024
# Description This is a follow-up of nushell/nushell.github.io#1584 The goal is to provide the user understanding of how to escape strings # User-Facing Changes Nothing except documentation # Tests + Formatting I don't know why but these two tests are failing on my system: - `test_std_util path_add` - `commands::umkdir::mkdir_umask_permission` Since I hardly believe it is linked to my changes, I will let your CI check it. Meanwhile, I will check my system, highly likely that it is something something related to me recently switching shells, hacking my way through prompts environments, etc. # After Submitting Will check how to re-generate the [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged
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.
Trying to escape a capture group name, I had to discover and read rust doc.
Finding it should be easy for people who wants to know the specification of the regex mode.
Adding a link to it will bring knowledge to users.
👍 Knowledge!
🤔 Should we copy rust doc here in order to not be coupled with it? I have the feeling Nushell<>rust coupling is intentional, this is why I am opening the PR this way