Skip to content

Commit 987c169

Browse files
Tweak documentation for AvoidUsingBrokenHashAlgorithms (#1829)
Prior to this change, the documentation for the new rule, **AvoidUsingBrokenHashAlgorithms**, was not reflowed and had the same metadata description as **UseCmdletCorrectly**. To keep this document in sync with the one in the published docset, this change reflows the document to 100 characters and corrects the metadata. This is related to the work in MicrosoftDocs/PowerShell-Docs-Modules#90.
1 parent a154270 commit 987c169

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/Rules/AvoidUsingBrokenHashAlgorithms.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Cmdlet Verbs
2+
description: Avoid using broken hash algorithms
33
ms.custom: PSSA v1.21.0
44
ms.date: 05/31/2022
55
ms.topic: reference
@@ -15,7 +15,9 @@ Avoid using the broken algorithms MD5 or SHA-1.
1515

1616
## How
1717

18-
Replace broken algorithms with secure alternatives. MD5 and SHA-1 should be replaced with SHA256, SHA384, SHA512, or other safer algorithms when possible, with MD5 and SHA-1 only being utilized by necessity for backwards compatibility.
18+
Replace broken algorithms with secure alternatives. MD5 and SHA-1 should be replaced with SHA256,
19+
SHA384, SHA512, or other safer algorithms when possible, with MD5 and SHA-1 only being utilized by
20+
necessity for backwards compatibility.
1921

2022
## Example 1
2123

0 commit comments

Comments
 (0)