Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
schaudhari6254888 committed Feb 20, 2024
1 parent 87b1df3 commit 3f1bcd8
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx

https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx

Original file line number Diff line number Diff line change
Expand Up @@ -115,5 +115,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx

Original file line number Diff line number Diff line change
Expand Up @@ -247,5 +247,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx

11 changes: 11 additions & 0 deletions src/EventHub/EventHub.Autorest/examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Examples
This directory contains examples from the exported cmdlets of the module. When `build-module.ps1` is ran, example stub files will be generated here. If your module support Azure Profiles, the example stubs will be in individual profile folders. These example stubs should be updated to show how the cmdlet is used. The examples are imported into the documentation when `generate-help.ps1` is ran.

## Info
- Modifiable: yes
- Generated: partial
- Committed: yes
- Packaged: no

## Purpose
This separates the example documentation details from the generated documentation information provided directly from the generated cmdlets. Since the cmdlets don't have examples from the REST spec, this provides a means to add examples easily. The example stubs provide the markdown format that is required. The 3 core elements are: the name of the example, the code information of the example, and the description of the example. That information, if the markdown format is followed, will be available to documentation generation and be part of the documents in the `../docs` folder.
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx

https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx

Original file line number Diff line number Diff line change
Expand Up @@ -121,5 +121,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx

Original file line number Diff line number Diff line change
Expand Up @@ -245,5 +245,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx

0 comments on commit 3f1bcd8

Please sign in to comment.