Skip to content

Commit d32d49e

Browse files
committed
Fix structure of About files
1 parent 0d5d8cc commit d32d49e

35 files changed

Lines changed: 81 additions & 42 deletions

reference/5.1/Microsoft.PowerShell.Core/About/about_Automatic_Variables.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ title: about_Automatic_Variables
1515
Describes variables that store state information for and are created and
1616
maintained by PowerShell.
1717

18+
## LONG DESCRIPTION
19+
1820
Conceptually, most of these variables are considered to be read-only. Even
1921
though they _can_ be written to, for backward compatibility they _should not_
2022
be written to.

reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ title: about_Comment_Based_Help
1010
# about_Comment_Based_Help
1111

1212
## SHORT DESCRIPTION
13+
1314
Describes how to write comment-based help content for functions and scripts.
1415

1516
## LONG DESCRIPTION

reference/5.1/Microsoft.PowerShell.Core/About/about_Environment_Variables.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,11 @@ title: about_Environment_Variables
99
# about_Environment_Variables
1010

1111
## SHORT DESCRIPTION
12+
1213
Describes how to access and manage environment variables in PowerShell.
1314

15+
## LONG DESCRIPTION
16+
1417
Environment variables store data that's used by the operating system and other
1518
programs. PowerShell creates the following environment variables:
1619

@@ -22,8 +25,6 @@ programs. PowerShell creates the following environment variables:
2225
For full descriptions of these variables, see the
2326
[PowerShell environment variables][03] of this article.
2427

25-
## LONG DESCRIPTION
26-
2728
PowerShell can access and manage environment variables in any of the supported
2829
operating system platforms. The PowerShell Environment provider lets you get,
2930
add, change, clear, and delete environment variables in the current console.

reference/5.1/Microsoft.PowerShell.Core/About/about_Intrinsic_Members.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: about_Intrinsic_Members
1414
Provides information about PowerShell's intrinsic members that are available to
1515
all PowerShell objects.
1616

17-
## DETAILED DESCRIPTION
17+
## LONG DESCRIPTION
1818

1919
When objects are created, PowerShell adds some "hidden" properties and methods
2020
to each object. These properties and methods are known as _intrinsic members_.

reference/5.1/Microsoft.PowerShell.Core/About/about_Job_Details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: about_Job_Details
1212

1313
Provides details about background jobs on local and remote computers.
1414

15-
## DETAILED DESCRIPTION
15+
## LONG DESCRIPTION
1616

1717
This topic explains the concept of a background job and provides technical
1818
information about how background jobs work in PowerShell.

reference/5.1/Microsoft.PowerShell.Core/About/about_Remote_Jobs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: about_Remote_Jobs
1212

1313
Describes how to run background jobs on remote computers.
1414

15-
## DETAILED DESCRIPTION
15+
## LONG DESCRIPTION
1616

1717
PowerShell concurrently runs commands and scripts through jobs. There are three
1818
jobs types provided by PowerShell to support concurrency.

reference/5.1/PSReadLine/About/about_PSReadLine.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ title: about_PSReadLine
1313
PSReadLine provides an improved command-line editing experience in the
1414
PowerShell console.
1515

16+
## LONG DESCRIPTION
17+
1618
There have been many updates to PSReadLine since the version that ships in
1719
Windows PowerShell 5.1.
1820

@@ -27,8 +29,6 @@ Windows PowerShell 5.1.
2729
For more information about version differences, see
2830
[about_PSReadLine_Release_Notes](about_PSReadLine_Release_Notes.md).
2931

30-
## LONG DESCRIPTION
31-
3232
The current version of PSReadLine can be installed and used on Windows
3333
PowerShell 5.1 and newer. For some features, you need to be running PowerShell
3434
7.2 or higher.

reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,16 @@ title: about_PSReadLine_Release_Notes
88
---
99
# about_PSReadLine_Release_Notes
1010

11+
## SHORT DESCRIPTION
12+
1113
This is a summary of changes to the **PSReadLine** module. For a full list of
1214
changes, see the **PSReadLine** [ChangeLog][01].
1315

1416
- Current preview: v2.4.4-beta4
1517
- Current stable release: v2.3.6
1618

19+
## LONG DESCRIPTION
20+
1721
## PSREADLINE RELEASE HISTORY
1822

1923
There have been many updates to PSReadLine since the version that ships in
@@ -27,8 +31,6 @@ Windows PowerShell 5.1.
2731
- v2.0.4 shipped in PowerShell 7.0.11
2832
- v2.0.0 ships in Windows PowerShell 5.1
2933

30-
## RELEASE NOTES
31-
3234
### 2.4.4-beta4 - 2025-08-28
3335

3436
- Added screen reader support to PSReadLine - The new render implementation

reference/7.4/Microsoft.PowerShell.Core/About/about_Automatic_Variables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ title: about_Automatic_Variables
1515
Describes variables that store state information for and are created and
1616
maintained by PowerShell.
1717

18+
## LONG DESCRIPTION
19+
1820
Conceptually, most of these variables are considered to be read-only. Even
1921
though they _can_ be written to, for backward compatibility they _should not_
2022
be written to.
@@ -69,8 +71,6 @@ Here is a list of the automatic variables in PowerShell:
6971
- [`$this`][47]
7072
- [`$true`][48]
7173

72-
## LONG DESCRIPTION
73-
7474
### `$$`
7575

7676
Contains the last token in the last line received by the session.

reference/7.4/Microsoft.PowerShell.Core/About/about_Calling_Generic_Methods.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ title: about_Calling_Generic_Methods
88
---
99
# about_Calling_Generic_Methods
1010

11+
## SHORT DESCRIPTION
12+
13+
A generic type is a parameterized type definition that you instantiate with
14+
concrete type arguments (like `List<T>`), giving reusable, type-safe code that
15+
the compiler and CLR handle efficiently.
16+
17+
## LONG DESCRIPTION
18+
1119
Generics let you tailor a method, class, structure, or interface to the precise
1220
data type it acts upon. For example, instead of using the
1321
[System.Collections.Hashtable][01] class, which allows keys and values to be

0 commit comments

Comments
 (0)