-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
Add some docs related to Update-Snippets.ps1 #13310
Add some docs related to Update-Snippets.ps1 #13310
Conversation
Co-authored-by: Mariana Rios Flores <mariari@microsoft.com>
/check-enforcer override |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for putting this together!
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we discuss convention for where you would normally find these, or how I could locate them?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for adding this!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you also add a blurb about including code snippets in our doc comments (see #11808 for details)?
/check-enforcer override |
This is intended to be a start to some documentation on how
Update-Snipppets
should be used. It may be incomplete or lacking details so any suggestions are welcome.