Add guidance for writing samples to DPG docs
See original GitHub issueBasic samples guidance is illustrated in: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/template/Azure.Template/samples.
Key features of Azure SDK .NET Samples include:
samples
directory:azure-sdk-for-net/tree/main/sdk/<service>/<library>/samples
: see exampleREADME.md
providing a TOC for all available samples under<library>/samples
: see exampleSample<i>_<scenario>.md
files describing the scenario the sample is illustrating under<library>/samples
: see exampletest/samples
directory:azure-sdk-for-net/tree/main/sdk/<service>/<library>/tests/samples
: see example- tests inheriting from TestFramework
SamplesBase
that implement all sample code under<library>/tests/samples
: see example - snippet regions identifying snippets to show in README and Samples files: see example
A nice example of a service library that follows the .NET samples guidance is MetricsAdvisor: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/metricsadvisor/Azure.AI.MetricsAdvisor
Issue Analytics
- State:
- Created 2 years ago
- Comments:5 (5 by maintainers)
Top Results From Across the Web
Consolidate partner guidance on samples · Issue #26444
Our goal is to make it possible for service partners building SDKs to be able to write samples in the correct format from...
Read more >What to do after generating the SDK code with codegen
You should add samples in the samples directory under ${PROJECT_ROOT}. Each sample should have its own folder and contain a Readme.md (example) ...
Read more >Dearpygui Tutorial
Dearpygui Tutorialwe can create a GUI of an application. Plots are composed of multiple components. A key-value pair tracks the type of the...
Read more >Dear PyGui documentation
Detailed documentation, examples and unparalleled support ... Below we will add a window, a group and a child container to the code items ......
Read more >Dearpygui Tutorial
Dear PyGui: A fast and powerful Graphical install dearpygui”. Tutorials do not cover every detail so refer to the documentation on each topic...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@annelo-msft We had no particular reason other than my lack of understanding about how the Test Framework works. I created an issue to track this work: https://github.com/Azure/azure-sdk-for-net/issues/27590
We don’t need to block on Consolidate smoke tests and best practices with DPG partner tools - we can loop back and update this after that merges.