Skip to content

Note that you can use String.Format placeholders #2011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 11, 2019

Conversation

tdykstra
Copy link
Contributor

@tdykstra tdykstra commented Mar 11, 2019

@rpetrusha
Copy link

Yes, @tdykstra, line breaks within the <format type="text/markdown"><![CDATA[ tag are handled as normal markdown.

@tdykstra
Copy link
Contributor Author

@rpetrusha I added a line break. Is this the best way to document the availability of placeholders in the errror message?

Copy link

@rpetrusha rpetrusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @tdykstra. This is a useful addition. A couple of comments:

  • "composite formatting placeholders" seems to me to be preferable to "String.Format placeholders". In either case, this should be a link either to the composite formatting topic (~/docs/standard/base-types/composite-formatting.md) or to String.Format (<xref:System.String.Format%2A?displayProperty=nameWithType>).
  • This remains a bit confusing, since the placeholders correspond to the zero-based index of arguments in the list that follows the format string. But I assume those are supplied automatically when the error message is generated at runtime. That should be made explicit.
  • An inline example would help.

@rpetrusha
Copy link

Sorry, @tdykstra. I didn't respond to your last question. Yes, it is.

@tdykstra
Copy link
Contributor Author

@rpetrusha What is / where do I find the staging URL?

@tdykstra
Copy link
Contributor Author

Found it -- staging URL

@tdykstra
Copy link
Contributor Author

This is ready for re-review

@rpetrusha
Copy link

This looks good, @tdykstra; thanks for making the additional changes. I'll merge your PR now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants