Fix dotnet/docs#8537 Update remark to topic examples #644
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
Fixes dotnet/docs#8537. This updates the wording that references the examples for the `RsaProtectedConfigurationProvider` class. Previously, examples were after this remark. The new wording references the examples without mention of how it's relatively positioned in the document.
mairaw
requested changes
Oct 22, 2018
Contributor
mairaw
left a comment
mairaw
left a comment
There was a problem hiding this comment.
Thank you @Chris-Johnston for jumping on the issue. I have a rewording suggestion. Let me know what you think!
| ## Remarks | ||
| The <xref:System.Configuration.RsaProtectedConfigurationProvider> class gives you a way to encrypt sensitive information stored in a configuration file, which helps protect it from unauthorized access. You use the built-in <xref:System.Configuration.RsaProtectedConfigurationProvider> instance by declaring the provider and making appropriate settings in the configuration file instead of creating an instance of this class, as shown in the example later in this topic. | ||
| The <xref:System.Configuration.RsaProtectedConfigurationProvider> class gives you a way to encrypt sensitive information stored in a configuration file, which helps protect it from unauthorized access. You use the built-in <xref:System.Configuration.RsaProtectedConfigurationProvider> instance by declaring the provider and making appropriate settings in the configuration file instead of creating an instance of this class, as shown in this topic's examples. |
Contributor
There was a problem hiding this comment.
my suggestion: as shown in the [Examples](#examples) section.
Contributor
Author
There was a problem hiding this comment.
Thanks for the feedback! I like the idea of using a link.
Suggested by GH user mairaw
mairaw
approved these changes
Oct 22, 2018
Contributor
mairaw
left a comment
mairaw
left a comment
There was a problem hiding this comment.
Thank you for making the suggested changes. I'll merge this as soon as the build finishes successfully.
mairaw
added
📁 Repo - dotnet-api-docs
✨ 1st-time dotnet-api-docs contributor!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
This updates the wording that references the examples for the
RsaProtectedConfigurationProviderclass. Previously, examples were after this remark. The new wording references the examples without mention of how it's relatively positioned in the document.Fixes dotnet/docs#8537.