Adding a few examples.

MethodsAndPractices · Aug 6, 2019 · f454a22 · f454a22
1 parent f65b6ab
commit f454a22
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 12 deletions.
diff --git a/.docs/Add-VSTeamMembership.md b/.docs/Add-VSTeamMembership.md
@@ -14,6 +14,16 @@
 
 ## EXAMPLES
 
+### -------------------------- EXAMPLE 1 --------------------------
+
+```PowerShell
+PS C:\> $user = Get-VSTeamUser | ? DisplayName -eq 'Test User'
+PS C:\> $group = Get-VSTeamGroup | ? DisplayName -eq 'Endpoint Administrators'
+PS C:\> Add-VSTeamMembership -MemberDescriptor $user.Descriptor -ContainerDescriptor $group.Descriptor
+```
+
+Adds Test User to the Endpoint Administrators group.
+
 ## PARAMETERS
 
 <!-- #include "./params/memberDescriptor.md" -->

diff --git a/.docs/Get-VSTeamGroup.md b/.docs/Get-VSTeamGroup.md
@@ -14,6 +14,14 @@
 
 ## EXAMPLES
 
+### -------------------------- EXAMPLE 1 --------------------------
+
+```PowerShell
+PS C:\> $group = Get-VSTeamGroup | ? DisplayName -eq 'Endpoint Administrators'
+```
+
+Assigns Endpoint Administrators group to $group variable.
+
 ## PARAMETERS
 
 <!-- #include "./params/projectName.md" -->

diff --git a/.docs/Get-VSTeamMembership.md b/.docs/Get-VSTeamMembership.md
@@ -13,14 +13,17 @@
 <!-- #include "./synopsis/Get-VSTeamMembership.md" -->
 
 ## EXAMPLES
+
 ### -------------------------- EXAMPLE 1 --------------------------
 
 ```PowerShell
-(Get-VSTeamMembership -MemberDescriptor $user.ID).value | % { Get-VSTeamGroup -Descriptor $_.containerdescriptor }
+(Get-VSTeamMembership -MemberDescriptor $user.ID).value | % { Get-VSTeamGroup -Descriptor $_.containerDescriptor }
 ```
+
 Get all the groups for a user
 
 ### -------------------------- EXAMPLE 2 --------------------------
+
 ```PowerShell
 (Get-VSTeamMembership -ContainerDescriptor $group.id).value | % {Get-VSTeamUser -Descriptor $_.memberDescriptor }
 ```
@@ -55,7 +58,6 @@ Position: 0
 
 ## OUTPUTS
 
-
 ## NOTES
 
 ## RELATED LINKS

diff --git a/.docs/Remove-VSTeamMembership.md b/.docs/Remove-VSTeamMembership.md
@@ -14,6 +14,16 @@
 
 ## EXAMPLES
 
+### -------------------------- EXAMPLE 1 --------------------------
+
+```PowerShell
+PS C:\> $user = Get-VSTeamUser | ? DisplayName -eq 'Test User'
+PS C:\> $group = Get-VSTeamGroup | ? DisplayName -eq 'Endpoint Administrators'
+PS C:\> Remove-VSTeamMembership -MemberDescriptor $user.Descriptor -ContainerDescriptor $group.Descriptor
+```
+
+Removes Test User from the Endpoint Administrators group.
+
 ## PARAMETERS
 
 <!-- #include "./params/memberDescriptor.md" -->

diff --git a/.docs/Test-VSTeamMembership.md b/.docs/Test-VSTeamMembership.md
@@ -23,7 +23,8 @@
 ## INPUTS
 
 ## OUTPUTS
-### $True or $False
+
+### System.Boolean
 
 ## NOTES
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,10 +30,10 @@ Updated help to refer to Add-VSTeamProfile instead of Set-VSTeamProfile
 Added support for Get-VSTeamJobRequest. The provider was extended to show the Job Request under the Agent.
 
 - Account
-   - Agent Pools
-     - Pool1
-       - Agent1
-         - JobRequest1
+  - Agent Pools
+    - Pool1
+      - Agent1
+        - JobRequest1
 
 ## 6.2.7
 

diff --git a/Source/en-US/VSTeam-Help.xml b/Source/en-US/VSTeam-Help.xml
@@ -9240,7 +9240,7 @@ ID Title          Status
     <command:examples>
       <command:example>
         <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
-        <dev:code>(Get-VSTeamMembership -MemberDescriptor $user.ID).value | % { Get-VSTeamGroup -Descriptor $_.containerdescriptor }</dev:code>
+        <dev:code>(Get-VSTeamMembership -MemberDescriptor $user.ID).value | % { Get-VSTeamGroup -Descriptor $_.containerDescriptor }</dev:code>
         <dev:remarks>
           <maml:para>Get all the groups for a user</maml:para>
         </dev:remarks>
@@ -17937,7 +17937,7 @@ PS demo:\&gt; Get-ChildItem</dev:code>
     <command:returnValues>
       <command:returnValue>
         <dev:type>
-          <maml:name>$True or $False</maml:name>
+          <maml:name>System.Boolean</maml:name>
         </dev:type>
         <maml:description>
           <maml:para></maml:para>

diff --git a/docs/Get-VSTeamMembership.md b/docs/Get-VSTeamMembership.md
@@ -14,14 +14,17 @@ Gets a memberships for a container or member.
 Gets a memberships for a container or member.
 
 ## EXAMPLES
+
 ### -------------------------- EXAMPLE 1 --------------------------
 
 ```PowerShell
-(Get-VSTeamMembership -MemberDescriptor $user.ID).value | % { Get-VSTeamGroup -Descriptor $_.containerdescriptor }
+(Get-VSTeamMembership -MemberDescriptor $user.ID).value | % { Get-VSTeamGroup -Descriptor $_.containerDescriptor }
 ```
+
 Get all the groups for a user
 
 ### -------------------------- EXAMPLE 2 --------------------------
+
 ```PowerShell
 (Get-VSTeamMembership -ContainerDescriptor $group.id).value | % {Get-VSTeamUser -Descriptor $_.memberDescriptor }
 ```
@@ -56,7 +59,6 @@ Position: 0
 
 ## OUTPUTS
 
-
 ## NOTES
 
 ## RELATED LINKS

diff --git a/docs/Test-VSTeamMembership.md b/docs/Test-VSTeamMembership.md
@@ -42,7 +42,8 @@ Position: 1
 ## INPUTS
 
 ## OUTPUTS
-### $True or $False
+
+### System.Boolean
 
 ## NOTES