Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add some docs related to Update-Snippets.ps1 #13310

Merged
merged 4 commits into from
Jul 9, 2020
Merged

Add some docs related to Update-Snippets.ps1 #13310

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5942141
Add some docs related to Update-Snippets.ps1
christothes Jul 8, 2020
38d228e
example suggestion
christothes Jul 8, 2020
507ab35
add example links
christothes Jul 8, 2020
edf74f6
pr comments
christothes Jul 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
example suggestion 
Co-authored-by: Mariana Rios Flores <mariari@microsoft.com>
  • Loading branch information
@christothes @maririos
christothes and maririos authored Jul 8, 2020
commit 38d228e7689612e2d026a305041c803ba261f387
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ eng\scripts\Export-API.ps1 tables
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.
christothes marked this conversation as resolved.
Show resolved Hide resolved
Any changes made to the snippet markdown should be done via updating the corresponding C# snippet code and subsequently running the script.
Copy link
Member

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?

Copy link
Member Author

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?

Copy link
Member

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.


Running the script for a project in `sdk\keyvault` would look like this:
Running the script for a project, for example in `sdk\keyvault`, would look like this:
```
eng\scripts\Update-Snippets.ps1 keyvault
christothes marked this conversation as resolved.
Show resolved Hide resolved
```
Expand Down