Remove incorrect information in Arguments docs. #16187
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
|
The documentation deleted here all seems still up-to-date to me, it may need an example for clarification but it's true that the only way to safely create |
| @@ -125,11 +125,6 @@ impl<'a> Arguments<'a> { | |||
| /// and its arguments. This cannot be generated at runtime because it cannot | |||
| /// safely be done so, so no constructors are given and the fields are private | |||
| /// to prevent modification. | |||
| /// | |||
| /// The `format_args!` macro will safely create an instance of this structure | |||
| /// and pass it to a user-supplied function. The macro validates the format | |||
There was a problem hiding this comment.
This paragraph is fine, please reinstate it (I think you could revise it to say, e.g., "and pass it to a function or closures supplied as the first argument").
|
Ah, I misunderstood what the beef was. What about now? |
| /// string at compile-time so usage of the `write` and `format` functions can | ||
| /// be safely performed. | ||
| /// and pass it to a function or closure, passed as the first argument. The | ||
| /// macro validates the forma string at compile-time so usage of the `write` |
|
Looks good to me! |
|
Fixed the typo. |
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.
Fixes #15830.