DOC: fix a broken docs example #4776
Merged
Conversation
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
jzuhone
previously approved these changes
Jan 1, 2024
|
I think it's necessary to emphasize explicitly where to use |
|
You're right. In the context of this example, do you think a comment on the line I added would be sufficient ? |
|
I'm not sure if it's obvious enough, but it would be better than now :) |
|
I'd like to keep the additional context minimalist to reduce the amount of churn and rotting docs if we can ever find a way to make it unneeded so I'll stick with a simple comment for now. |
neutrinoceros
force-pushed
the
hotfix_4774
branch
from
8e4a5df to
9df303e
Compare
chrishavlin
approved these changes
Jan 2, 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.
Close #4774