Fix example on Composit format string #49284
Open
+1
−1
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
The example on (Composite format string)[https://learn.microsoft.com/en-us/dotnet/standard/base-types/composite-formatting#composite-format-string] was reffering to a object called name. However, the String.Format method was using simply a string.
dotnet-policy-service
bot
added
dotnet-fundamentals/svc
community-contribution
There was a problem hiding this comment.
Pull Request Overview
Fix a documentation inaccuracy in the Composite formatting article by aligning the explanatory text with the actual example arguments.
- Clarifies that index 0 refers to the string "Fred" instead of an object named "name".
- Keeps the rest of the explanation intact.
|
|
||
| <!-- markdownlint-disable-next-line no-space-in-code --> | ||
| The fixed text is `Name = ` and `, hours = `. The format items are `{0}`, whose index of 0 corresponds to the object `name`, and `{1:hh}`, whose index of 1 corresponds to the object `DateTime.Now`. | ||
| The fixed text is `Name = ` and `, hours = `. The format items are `{0}`, whose index of 0 corresponds to the string `"Fred"`, and `{1:hh}`, whose index of 1 corresponds to the object `DateTime.Now`. |
There was a problem hiding this comment.
[nitpick] The phrase "object DateTime.Now" is imprecise here; consider clarifying terminology and using "string literal" for consistency. Suggested rewrite: "The fixed text is Name = and , hours = . The format items are {0}, whose index of 0 corresponds to the string literal "Fred", and {1:hh}, whose index of 1 corresponds to the value of DateTime.Now."
Suggested change
| The fixed text is `Name = ` and `, hours = `. The format items are `{0}`, whose index of 0 corresponds to the string `"Fred"`, and `{1:hh}`, whose index of 1 corresponds to the object `DateTime.Now`. | |
| The fixed text is `Name = ` and `, hours = `. The format items are `{0}`, whose index of 0 corresponds to the string literal `"Fred"`, and `{1:hh}`, whose index of 1 corresponds to the value of `DateTime.Now`. |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
The example on Composite format string formatting was reffering to an object called name. However, the String.Format method was using simply a string.
Internal previews