Skip to content

Commit f04943b

Browse files
Fix some minor docs issues
1 parent 81ec5dd commit f04943b

File tree

5 files changed

+57
-46
lines changed

5 files changed

+57
-46
lines changed

docs/en-US/Find-Member.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Find all members in the AppDomain with the name "GetPowerShell"
6262
# Read Method public virtual int Read(Span<byte> buffer);
6363
```
6464

65-
Find all members in the AppDomain with the name "GetPowerShell"
65+
Find all members that take a `Span<>` or a `Memory<>` as a parameter.
6666

6767
### -------------------------- EXAMPLE 3 --------------------------
6868

@@ -90,7 +90,7 @@ Find-Member -ParameterCount 0 -GenericParameter { [T[new]] }
9090

9191
Find all methods with no parameters and with a generic parameter with the `new` constraint.
9292

93-
### -------------------------- EXAMPLE 3 --------------------------
93+
### -------------------------- EXAMPLE 4 --------------------------
9494

9595
```powershell
9696
Find-Member Emit -ParameterCount ..1, 7..8, 10..
@@ -123,7 +123,7 @@ Find all methods named `Emit` whose parameter count is any of the following:
123123
2. `7..8`: Between 7 and 8 inclusive
124124
3. `10..`: Greater than or equal to 10
125125

126-
### -------------------------- EXAMPLE 4 --------------------------
126+
### -------------------------- EXAMPLE 5 --------------------------
127127

128128
```powershell
129129
Find-Member -ReturnType System.Management.Automation.Language.Ast -Static
@@ -151,7 +151,7 @@ Find-Member -ReturnType System.Management.Automation.Language.Ast -Static
151151

152152
Find all static members in the AppDomain that return any type of AST.
153153

154-
### -------------------------- EXAMPLE 5 --------------------------
154+
### -------------------------- EXAMPLE 6 --------------------------
155155

156156
```powershell
157157
Find-Member -ParameterType runspace -Virtual
@@ -171,7 +171,7 @@ Find-Member -ParameterType runspace -Virtual
171171

172172
Find all virtual members in the AppDomain that take any runspace type as a parameter.
173173

174-
### -------------------------- EXAMPLE 6 --------------------------
174+
### -------------------------- EXAMPLE 7 --------------------------
175175

176176
```powershell
177177
Find-Member Parse* -ParameterType System.Management.Automation.Language.Token
@@ -188,7 +188,7 @@ Find-Member Parse* -ParameterType System.Management.Automation.Language.Token
188188
Find all members that start with the word Parse and take Token as a parameter. This example also
189189
demonstrates how this will even match the element of a type that is both an array and ByRef type.
190190

191-
### -------------------------- EXAMPLE 7 --------------------------
191+
### -------------------------- EXAMPLE 8 --------------------------
192192

193193
```powershell
194194
[runspace] | Find-Member -Force -Abstract | Find-Member -Not -AccessView Child
@@ -207,7 +207,7 @@ demonstrates how this will even match the element of a type that is both an arra
207207

208208
Find all members that are required to be implemented (abstract) but cannot be implemented outside of the origin assembly.
209209

210-
### -------------------------- EXAMPLE 8 --------------------------
210+
### -------------------------- EXAMPLE 9 --------------------------
211211

212212
```powershell
213213
$members = Find-Member -Force
@@ -397,6 +397,18 @@ Specifies the amount of parameters a method must accept to match. This requireme
397397

398398
Multiple range expressions can be specified by separating with `,`. The member will fit the criteria as long at least one range expression matches.
399399

400+
```yaml
401+
Type: RangeExpression[]
402+
Parameter Sets: (All)
403+
Aliases: pc
404+
405+
Required: False
406+
Position: Named
407+
Default value: None
408+
Accept pipeline input: False
409+
Accept wildcard characters: False
410+
```
411+
400412
### -GenericParameterCount
401413

402414
Specifies the amount of generic parameters a method must accept to match. This requirement can be expressed in the following ways:
@@ -424,7 +436,7 @@ Accept wildcard characters: False
424436

425437
Specifies a type that a member must accept as a parameter to be matched. This parameter will also match base types, implemented interfaces, and the element type of array, byref, pointer and generic types.
426438

427-
This can also be a type signature (see [about_Type_Signatures](https://bit.ly/about-type-signatures)).
439+
This can also be a type signature (see [about_Type_Signatures](https://seemingly.dev/about-type-signatures)).
428440

429441
```yaml
430442
Type: ScriptBlockStringOrType
@@ -442,7 +454,7 @@ Accept wildcard characters: False
442454

443455
Specifies a type that a member must accept as a generic type parameter to be matched. This parameter will also match base types, implemented interfaces and other generic constraints.
444456

445-
This can also be a type signature (see [about_Type_Signatures](https://bit.ly/about-type-signatures)).
457+
This can also be a type signature (see [about_Type_Signatures](https://seemingly.dev/about-type-signatures)).
446458

447459
```yaml
448460
Type: ScriptBlockStringOrType
@@ -476,7 +488,7 @@ Accept wildcard characters: False
476488

477489
Specifies a type that a member must return to match. This includes property types, field types, and method return types. This parameter will also match base types, implemented interfaces, and the element type of array, byref, pointer and generic types.
478490

479-
This can also be a type signature (see [about_Type_Signatures](https://bit.ly/about-type-signatures)).
491+
This can also be a type signature (see [about_Type_Signatures](https://seemingly.dev/about-type-signatures)).
480492

481493
```yaml
482494
Type: Type
@@ -494,7 +506,7 @@ Accept wildcard characters: False
494506

495507
Specifies that a member must be decorated with this attribute for it to be included in results. This search will be done based on type name rather than strict type identity so it is safe to use for embedded attributes.
496508

497-
This can also be a type signature (see [about_Type_Signatures](https://bit.ly/about-type-signatures)).
509+
This can also be a type signature (see [about_Type_Signatures](https://seemingly.dev/about-type-signatures)).
498510

499511
```yaml
500512
Type: Type

docs/en-US/Find-Type.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Accept wildcard characters: True
153153

154154
### -ImplementsInterface
155155

156-
Specifies a interface that the type must implement to match. This can also be a type signature (see [about_Type_Signatures](https://bit.ly/about-type-signatures)).
156+
Specifies a interface that the type must implement to match. This can also be a type signature (see [about_Type_Signatures](https://seemingly.dev/about-type-signatures)).
157157

158158
```yaml
159159
Type: ClassExplorer.ScriptBlockStringOrType
@@ -169,7 +169,7 @@ Accept wildcard characters: False
169169

170170
### -InheritsType
171171

172-
Specifies a type that the type must inherit to match. This can also be a type signature (see [about_Type_Signatures](https://bit.ly/about-type-signatures)).
172+
Specifies a type that the type must inherit to match. This can also be a type signature (see [about_Type_Signatures](https://seemingly.dev/about-type-signatures)).
173173

174174
```yaml
175175
Type: ClassExplorer.ScriptBlockStringOrType
@@ -185,7 +185,7 @@ Accept wildcard characters: False
185185

186186
### -Signature
187187

188-
Specifies a type signature to match. See [about_Type_Signatures](https://bit.ly/about-type-signatures).
188+
Specifies a type signature to match. See [about_Type_Signatures](https://seemingly.dev/about-type-signatures).
189189

190190
```yaml
191191
Type: ClassExplorer.ScriptBlockStringOrType
@@ -411,7 +411,7 @@ Accept wildcard characters: False
411411

412412
If you pass assemblies to this cmdlet it will match types from that assembly.
413413

414-
If you pass Type objects as input this cmdlet will return the input if it matches the specified criteria. You can use this to chain Find-Type commands to filter output.
414+
If you pass Type objects as input this cmdlet will return the input if it matches the specified criteria. You can use this to chain Find-Type commands to filter output.
415415

416416
If you pass any other object to this cmdlet it will return the type of that object.
417417

docs/en-US/Get-Assembly.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,11 @@ Get all assemblies loaded into the current AppDomain
3838
```powershell
3939
Get-Assembly *Automation*
4040
41-
# GAC Version Location
42-
# --- ------- --------
43-
# False v4.0.30319 C:\Program Files\PowerShell\default\System.Management.…
41+
# Directory: C:\Program Files\PowerShell\7-preview
42+
43+
# Version Name PublicKeyToken Target Culture
44+
# ------- ---- -------------- ------ -------
45+
# 7.3.0.3 System.Management.Automation 31bf3856ad364e35 MSIL neutral
4446
```
4547

4648
Get assemblies that match a wildcard.

docs/en-US/Get-Parameter.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,26 +27,23 @@ The Get-Parameter cmdlet gets parameter info from a member.
2727
```powershell
2828
[powershell] | Find-Member Create | Get-Parameter
2929
30-
# Member: System.Management.Automation.PowerShell
31-
# Create(System.Management.Automation.RunspaceMode)
30+
# Member: public static PowerShell Create(RunspaceMode runspace);
3231
#
33-
# # ParameterType Name IsIn IsOut IsOpt
34-
# - ------------- ---- ---- ----- -----
35-
# 0 RunspaceMode runspace False False False
32+
# # Type Name Default In Out Opt
33+
# - ---- ---- ------- -- --- ---
34+
# 0 RunspaceMode runspace x x x
3635
#
37-
# Member: System.Management.Automation.PowerShell
38-
# Create(System.Management.Automation.Runspaces.InitialSessionState)
36+
# Member: public static PowerShell Create(InitialSessionState initialSessionState);
3937
#
40-
# # ParameterType Name IsIn IsOut IsOpt
41-
# - ------------- ---- ---- ----- -----
42-
# 0 InitialSessionState initialSessionState False False False
38+
# # Type Name Default In Out Opt
39+
# - ---- ---- ------- -- --- ---
40+
# 0 InitialSessionState initialSessionState x x x
4341
#
44-
# Member: System.Management.Automation.PowerShell
45-
# Create(System.Management.Automation.Runspaces.Runspace)
42+
# Member: public static PowerShell Create(Runspace runspace);
4643
#
47-
# # ParameterType Name IsIn IsOut IsOpt
48-
# - ------------- ---- ---- ----- -----
49-
# 0 Runspace runspace False False False
44+
# # Type Name Default In Out Opt
45+
# - ---- ---- ------- -- --- ---
46+
# 0 Runspace runspace x x x
5047
```
5148

5249
Get parameters for all overloads of the PowerShell.Create method.

src/ClassExplorer/SR.resx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -121,45 +121,45 @@
121121
<value>Expected {0} arguments for "{1}".</value>
122122
</data>
123123
<data name="NotSingleTypeExpression" xml:space="preserve">
124-
<value>Expected exactly one type expression. See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
124+
<value>Expected exactly one type expression. See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
125125
</data>
126126
<data name="NotTypeExpression" xml:space="preserve">
127-
<value>Expected type expression. See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
127+
<value>Expected type expression. See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
128128
</data>
129129
<data name="DecorationBadArgs" xml:space="preserve">
130-
<value>The keyword "decoration" requires exactly one generic argument (Example: [decoration[ParameterAttribute]]). See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
130+
<value>The keyword "decoration" requires exactly one generic argument (Example: [decoration[ParameterAttribute]]). See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
131131
</data>
132132
<data name="TypeNotFound" xml:space="preserve">
133133
<value>Unable to find type [{0}].</value>
134134
</data>
135135
<data name="GenericBadArgCount" xml:space="preserve">
136-
<value>The keyword "generic" requires exactly two generic arguments (Example: [generic[exact[IReadOnlyDictionary], args[any, any]]]). See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
136+
<value>The keyword "generic" requires exactly two generic arguments (Example: [generic[exact[IReadOnlyDictionary], args[any, any]]]). See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
137137
</data>
138138
<data name="GenericBadSecondArg" xml:space="preserve">
139-
<value>The keyword "generic" requires the second argument to be args[...] (Example: [generic[exact[IReadOnlyDictionary], args[any, any]]]). See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
139+
<value>The keyword "generic" requires the second argument to be args[...] (Example: [generic[exact[IReadOnlyDictionary], args[any, any]]]). See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
140140
</data>
141141
<data name="PointerBadArgCount" xml:space="preserve">
142-
<value>The keyword "pointer" requires exactly two generic arguments (Example: [pointer[void, a1..2]]). See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
142+
<value>The keyword "pointer" requires exactly two generic arguments (Example: [pointer[void, a1..2]]). See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
143143
</data>
144144
<data name="PointerBadSecondArg" xml:space="preserve">
145-
<value>The keyword "pointer" requires the second argument to be a range expression prefixed with the letter 'a' (Example: [pointer[void, a1..2]]). See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
145+
<value>The keyword "pointer" requires the second argument to be a range expression prefixed with the letter 'a' (Example: [pointer[void, a1..2]]). See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
146146
</data>
147147
<data name="PointerBadRangeExpression" xml:space="preserve">
148-
<value>Range expression provided for keyword "pointer" is invalid. (Example: [pointer[void, a1..2]]). See https://bit.ly/about-type-signatures or help about_Type_Signatures.
148+
<value>Range expression provided for keyword "pointer" is invalid. (Example: [pointer[void, a1..2]]). See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.
149149

150150
Message: {0}</value>
151151
</data>
152152
<data name="BadArgCount" xml:space="preserve">
153-
<value>The keyword "{0}" requires exactly one argument. See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
153+
<value>The keyword "{0}" requires exactly one argument. See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
154154
</data>
155155
<data name="NeedsMoreArgs" xml:space="preserve">
156-
<value>The keyword "{0}" requires at least {1} arguments. See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
156+
<value>The keyword "{0}" requires at least {1} arguments. See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
157157
</data>
158158
<data name="NeedsLessArgs" xml:space="preserve">
159-
<value>The keyword "{0}" requires at most {1} arguments. See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
159+
<value>The keyword "{0}" requires at most {1} arguments. See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
160160
</data>
161161
<data name="ArgMustBeResolvable" xml:space="preserve">
162-
<value>The generic argument for keyword "{0}" must be a resolvable type. See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
162+
<value>The generic argument for keyword "{0}" must be a resolvable type. See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
163163
</data>
164164
<data name="Unreachable" xml:space="preserve">
165165
<value>This program location is thought to be unreachable.</value>
@@ -168,7 +168,7 @@ Message: {0}</value>
168168
<value>Unexpected custom attribute argument type "{0}". Value: {1}</value>
169169
</data>
170170
<data name="ConvertMustBeRef" xml:space="preserve">
171-
<value>Convert expressions (e.g. [ref] [type]) must be "anyref", "in", "out", or "ref". See https://bit.ly/about-type-signatures or help about_Type_Signatures.</value>
171+
<value>Convert expressions (e.g. [ref] [type]) must be "anyref", "in", "out", or "ref". See https://seemingly.dev/about-type-signatures or help about_Type_Signatures.</value>
172172
</data>
173173
<data name="ResolveMapNullValue" xml:space="preserve">
174174
<value>Cannot convert null to type "System.Type".</value>

0 commit comments

Comments
 (0)