Misc markdown rules fixes for 7.5 #11517
Conversation
ExpectationsThanks for your submission! Here's a quick note to provide you with some context for what to expect from the docs team and the process now that you've submitted a PR. Even if you've contributed to this repo before, we strongly suggest reading this information; it might have changed since you last read it. To see our process for reviewing PRs, please read our editor's checklist and process for managing pull requests in particular. Below is a brief, high-level summary of what to expect, but our contributor guide has expanded details. The docs team begins to review your PR if you request them to or if your PR meets these conditions:
You can always request a review at any stage in your authoring process, the docs team is here to help! You do not need to submit a fully polished and finished draft; the docs team can help you get content ready for merge. While reviewing your PR, the docs team may make suggestions, write comments, and ask questions. When all requirements are satisfied, the docs team marks your PR as Approved and merges it. Once your PR is merged, it is included the next time the documentation is published. For this project, the documentation is published daily at 3 p.m. Pacific Standard Time (PST). |
| @@ -59,7 +59,7 @@ PowerShell provides the ability to dynamically add new properties and alter the | |||
|
|
|||
| ### [about_Calling_Generic_Methods](about_Calling_Generic_Methods.md) | |||
|
|
|||
| A generic method is a method with two parameter lists: a list of generic types and a list of method arguments. The following examples show the new PowerShell syntax for accessing a generic method: ```Syntax # static generic methods [type_name]::MethodName[generic_type_arguments](method_arguments) # instance generic methods $object.MethodName[generic_type_arguments](method_arguments) ``` The `generic_type_arguments` can be a single type or comma-separated list of types, like `[string, int]`, including other generic types like `$obj.MethodName[string, System.Collections.Generic.Dictionary[string, int]]()` The `method_arguments` can be zero or more items. For more information, see [Generics in .NET](/dotnet/standard/generics/). | |||
| A generic method is a method with two parameter lists: a list of generic types and a list of method arguments. The following examples show the new PowerShell syntax for accessing a generic method: ```Syntax # static generic methods [type_name]::MethodName[generic_type_arguments](method_arguments) # instance generic methods $object.MethodName[generic_type_arguments](method_arguments)``` The `generic_type_arguments` can be a single type or comma-separated list of types, like `[string, int]`, including other generic types like `$obj.MethodName[string, System.Collections.Generic.Dictionary[string, int]]()` The `method_arguments` can be zero or more items. For more information, see [Generics in .NET](/dotnet/standard/generics/). | |||
There was a problem hiding this comment.
I need to fix this one. This synopsis shouldn't include all of this information. It should be a single sentence. Let me fix this then rebase.
There was a problem hiding this comment.
This is fixed now. You shouldn't need to include it in your PR. Please resync the main branch and rebase.
| @@ -155,7 +155,7 @@ Describes the PowerShell execution policies and explains how to manage them. | |||
|
|
|||
| ### [about_Experimental_Features](about_Experimental_Features.md) | |||
|
|
|||
| Use the `Experimental` attribute to declare some code as experimental. Use the following syntax to declare the `Experimental` attribute providing the name of the experimental feature and the action to take if the experimental feature is enabled: ```csharp [Experimental(NameOfExperimentalFeature, ExperimentAction)] ``` For modules, the `NameOfExperimentalFeature` must follow the form of `<modulename>.<experimentname>`. The `ExperimentAction` parameter must be specified and the only valid values are: - `Show` means to show this experimental feature if the feature is enabled - `Hide` means to hide this experimental feature if the feature is enabled | |||
| Use the `Experimental` attribute to declare some code as experimental. Use the following syntax to declare the `Experimental` attribute providing the name of the experimental feature and the action to take if the experimental feature is enabled: ```csharp [Experimental(NameOfExperimentalFeature, ExperimentAction)]``` For modules, the `NameOfExperimentalFeature` must follow the form of `<modulename>.<experimentname>`. The `ExperimentAction` parameter must be specified and the only valid values are: - `Show` means to show this experimental feature if the feature is enabled - `Hide` means to hide this experimental feature if the feature is enabled | |||
There was a problem hiding this comment.
Same problem with this one.
| @@ -500,7 +500,7 @@ from newest to oldest. | |||
|
|
|||
| Event Tracing for Windows (ETW) writes events to the log as events occur. The events are stored in | |||
| the order of oldest to newest. An archived ETW file is saved as an `.etl` such as **TraceLog.etl**. | |||
| The events are listed in the order in which they are written to the log, so the *Oldest* parameter | |||
| The events are listed in the order in which they are written to the log, so the _Oldest_ parameter | |||
There was a problem hiding this comment.
Parameter names (in prose) should be bold - see https://learn.microsoft.com/en-us/powershell/scripting/community/contributing/editorial-checklist?view=powershell-7.4#formatting
| The events are listed in the order in which they are written to the log, so the _Oldest_ parameter | |
| The events are listed in the order in which they are written to the log, so the **Oldest** parameter |
There was a problem hiding this comment.
Ok, so the original was wrong in this case. From MD perspective, it just pointed to the wrong character being used.
| @@ -140,7 +140,7 @@ In this example, no parameter names are used, thus "a" binds to `Path`, "b" to ` | |||
|
|
|||
| ### -AdditionalChildPath | |||
|
|
|||
| Specifies additional elements to append to the value of the *Path* parameter. The `ChildPath` | |||
| Specifies additional elements to append to the value of the _Path_ parameter. The `ChildPath` | |||
There was a problem hiding this comment.
| Specifies additional elements to append to the value of the _Path_ parameter. The `ChildPath` | |
| Specifies additional elements to append to the value of the **Path** parameter. The **ChildPath** |
| @@ -171,7 +171,7 @@ Forces the cmdlet to set items that cannot otherwise be changed, such as read-on | |||
| variables. The cmdlet cannot change constant aliases or variables. | |||
| Implementation varies from provider to provider. | |||
| For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md). | |||
| Even using the *Force* parameter, the cmdlet cannot override security restrictions. | |||
| Even using the _Force_ parameter, the cmdlet cannot override security restrictions. | |||
There was a problem hiding this comment.
| Even using the _Force_ parameter, the cmdlet cannot override security restrictions. | |
| Even using the **Force** parameter, the cmdlet cannot override security restrictions. |
| @@ -70,7 +70,7 @@ PS C:\> dir C:\Downloads\*PowerShell* | Unblock-File | |||
|
|
|||
| This command shows how to find and unblock PowerShell scripts. | |||
|
|
|||
| The first command uses the **Stream** parameter of the *Get-Item* cmdlet get files with the | |||
| The first command uses the **Stream** parameter of the _Get-Item_ cmdlet get files with the | |||
There was a problem hiding this comment.
Cmdlet names should be in code spans per our style guide.
| The first command uses the **Stream** parameter of the _Get-Item_ cmdlet get files with the | |
| The first command uses the **Stream** parameter of the `Get-Item` cmdlet get files with the |
There was a problem hiding this comment.
Ok, so the original was wrong in this case. From MD perspective, it just pointed to the wrong character being used.
|
Learn Build status updates of commit 228be72: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
|
Ill open a new one with same fixes plus suggestions from this one |
PR Summary
Two left overs MD026 and MD31 from previous sessions.
2 more small PRs to go after this and 7.5 should be in great shape !
PR Checklist