Nit: use single ticks not double

Signed-off-by: Eric Brown <[email protected]>
securesauce · Mar 7, 2024 · 06907ca · 06907ca
1 parent af74570
commit 06907ca
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/precli/rules/go/stdlib/crypto_weak_hash.py b/precli/rules/go/stdlib/crypto_weak_hash.py
@@ -36,7 +36,7 @@
 ## Remediation
 
 The recommendation is to swap the insecure hashing method to one of the more
-secure alternatives, ``sha256`` or ``sha512``.
+secure alternatives, `sha256` or `sha512`.
 
 ```go
 package main

diff --git a/precli/rules/python/stdlib/crypt_weak_hash.py b/precli/rules/python/stdlib/crypt_weak_hash.py
@@ -1,6 +1,6 @@
 # Copyright 2024 Secure Saurce LLC
 r"""
-# Reversible One Way Hash in ``crypt`` Module
+# Reversible One Way Hash in `crypt` Module
 
 The Python module `crypt` provides a number of functions for password
 hashing. However, some of the hashing functions supported by `crypt` are weak
@@ -38,7 +38,7 @@
 ## Remediation
 
 The recommendation is to swap the insecure hashing method to one of the more
-secure alternatives, ``SHA256`` or ``SHA512``.
+secure alternatives, `SHA256` or `SHA512`.
 
 ```python
 import crypt

diff --git a/precli/rules/python/stdlib/ftplib_cleartext.py b/precli/rules/python/stdlib/ftplib_cleartext.py
@@ -2,7 +2,7 @@
 r"""
 # Cleartext Transmission of Sensitive Information in the `ftplib` Module
 
-The Python module ``ftplib`` provides a number of functions for accessing FTP
+The Python module `ftplib` provides a number of functions for accessing FTP
 servers. However, the module does not provide any security features. This
 means that data transmitted over the network, including passwords, is sent
 in cleartext. This makes it possible for attackers to intercept and read
@@ -31,8 +31,8 @@
 ## Remediation
 
 If the FTP protocol must be used and sensitive data will be transferred, it
-is recommended to secure the connection using ``FTP_TLS`` class. It's also
-important to call ``prot_p()`` to secure the data connection.
+is recommended to secure the connection using `FTP_TLS` class. It's also
+important to call `prot_p()` to secure the data connection.
 
 ```python
 import ftplib

diff --git a/precli/rules/python/stdlib/hashlib_weak_hash.py b/precli/rules/python/stdlib/hashlib_weak_hash.py
@@ -1,6 +1,6 @@
 # Copyright 2024 Secure Saurce LLC
 r"""
-# Reversible One Way Hash in ``hashlib`` Module
+# Reversible One Way Hash in `hashlib` Module
 
 The Python module `hashlib` provides a number of functions for hashing data.
 However, some of the hash algorithms supported by hashlib are insecure and

diff --git a/precli/rules/python/stdlib/hmac_weak_hash.py b/precli/rules/python/stdlib/hmac_weak_hash.py
@@ -42,7 +42,7 @@
 ## Remediation
 
 The recommendation is to swap the insecure hashing method to one of the more
-secure alternatives, ``SHA256``, ``SHA-384``, or ``SHA512``.
+secure alternatives, `SHA256`, `SHA-384`, or `SHA512`.
 
 ```python
 import hmac