Prompt specifiers: documentation improvements #926
Merged
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
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Apr 18, 2024
artur-intech
pushed a commit
to artur-intech/ruby
that referenced
this pull request
Apr 26, 2024
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.
While reading the docs for specifying your own custom prompt, I noticed a few issues.
First, the placeholder for specifying the indentation level and the line number are wrong.
*NN*idoes not work, nor*NN*n(replacing NN with digits of course). The right placeholders are actually%NNiand%NNn.Additionally, it took me a lot of time to understand that NN meant that I had to use digits and not actual NN in the placeholder 🤣. I have added a brief line for both the placeholders that actually states that you should use digits and not the raw NN.
PR's open for discussion 😃.