From 987c169e5fb2d9915660a3f8fa8886b5e956139b Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Mon, 15 Aug 2022 13:18:07 -0500 Subject: [PATCH] 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. --- docs/Rules/AvoidUsingBrokenHashAlgorithms.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/Rules/AvoidUsingBrokenHashAlgorithms.md b/docs/Rules/AvoidUsingBrokenHashAlgorithms.md index 5f0406934..83b75929c 100644 --- a/docs/Rules/AvoidUsingBrokenHashAlgorithms.md +++ b/docs/Rules/AvoidUsingBrokenHashAlgorithms.md @@ -1,5 +1,5 @@ --- -description: Cmdlet Verbs +description: Avoid using broken hash algorithms ms.custom: PSSA v1.21.0 ms.date: 05/31/2022 ms.topic: reference @@ -15,7 +15,9 @@ Avoid using the broken algorithms MD5 or SHA-1. ## How -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. +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. ## Example 1