question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add guidance for writing samples to DPG docs

See original GitHub issue

Basic 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 example
  • README.md providing a TOC for all available samples under <library>/samples: see example
  • Sample<i>_<scenario>.md files describing the scenario the sample is illustrating under <library>/samples: see example
  • test/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:closed
  • Created 2 years ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
kinelskicommented, Mar 16, 2022

@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

0reactions
annelo-msftcommented, Mar 30, 2022

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.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found