Skip to content

Commit 6b8502f

Browse files
(MAINT) Clarify line length for about topics (#11307)
* (MAINT) Clarify line length for about topics Prior to this change, the contributing guide indicated that the line length should be limited to 100 characters. It clarified that this guideline applies to conceptual articles and cmdlet reference, but didn't indicate that the line length in `about_` topics should be limited to 80 characters. This change clarifies the guidance. * Update reference/docs-conceptual/community/contributing/general-markdown.md --------- Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>
1 parent ec1d7f4 commit 6b8502f

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

reference/docs-conceptual/community/contributing/general-markdown.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: This article provides specific guidance for using Markdown in our documentation.
3-
ms.date: 04/23/2024
3+
ms.date: 08/01/2024
44
title: Markdown best practices
55
---
66
# Markdown best practices
@@ -50,9 +50,9 @@ Only use [ATX headings][07] (`#` style, as opposed to `=` or `-` style headers).
5050

5151
## Limit line length to 100 characters
5252

53-
This applies to conceptual articles and cmdlet reference. Limiting the line length improves the
54-
readability of `git` diffs and history. It also makes it easier for other writers to make
55-
contributions.
53+
This applies to conceptual articles and cmdlet reference. For `about_` topics, limit the line
54+
length to 79 characters. Limiting the line length improves the readability of `git` diffs and
55+
history. It also makes it easier for other writers to make contributions.
5656

5757
Use the [Reflow Markdown][09] extension in VS Code to reflow paragraphs to fit the prescribed line
5858
length.

0 commit comments

Comments
 (0)