Add some docs related to Update-Snippets.ps1 #13310
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
christothes
added
the
Client
pakrym
approved these changes
Jul 8, 2020
maririos
reviewed
Jul 8, 2020
maririos
reviewed
Jul 8, 2020
maririos
reviewed
Jul 8, 2020
maririos
approved these changes
Jul 8, 2020
Co-authored-by: Mariana Rios Flores <mariari@microsoft.com>
|
/check-enforcer override |
jsquire
reviewed
Jul 8, 2020
| @@ -151,6 +151,36 @@ Running the script for a project in `sdk\tables` would look like this: | |||
| eng\scripts\Export-API.ps1 tables | |||
| ``` | |||
|
|
|||
| ## Updating Sample Snippets | |||
| If the specific client library has sample snippets in markdown format, they were most likely created with help of the `eng\scripts\Update-Snippets.ps1` script. | |||
| Any changes made to the snippet markdown should be done via updating the corresponding C# snippet code and subsequently running the script. | |||
There was a problem hiding this comment.
Should we discuss convention for where you would normally find these, or how I could locate them?
There was a problem hiding this comment.
I feel like this is mostly covered by the directly linked examples below and the reference to the samples guidelines. Do you think being more explicit with a dir structure example here would help make it more clear?
There was a problem hiding this comment.
It's a fair point. I can see someone clicking the sample and looking at the resulting code but not thinking to pay attention to the path, but I could just be overthinking it.
jsquire
approved these changes
Jul 8, 2020
|
/check-enforcer override |
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.
This is intended to be a start to some documentation on how
Update-Snipppetsshould be used. It may be incomplete or lacking details so any suggestions are welcome.