From 0390b15f3529c0581062642dd6354f9375cb65a1 Mon Sep 17 00:00:00 2001
From: Jose Raul Barreras <barreras@unl.edu>
Date: Thu, 30 May 2019 18:00:40 -0500
Subject: [PATCH] improve doc
---
README.md | 2 +-
examples/Detect-Secrets.md | 2 ++
2 files changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 86cd968..ea5b735 100644
--- a/README.md
+++ b/README.md
@@ -27,4 +27,4 @@ This file is automatically updated after execute `git commit` based on the conte
- its-registry.unl.edu/unl-its/docker-ci/static-code-analysis:python
-
_Last update: Thu May 30 17:58:53 CDT 2019_
+
_Last update: Thu May 30 18:00:40 CDT 2019_
diff --git a/examples/Detect-Secrets.md b/examples/Detect-Secrets.md
index 17e981a..cfc1e5e 100644
--- a/examples/Detect-Secrets.md
+++ b/examples/Detect-Secrets.md
@@ -26,8 +26,10 @@ variables:
# Inline Allowlisting
To tell detect-secrets to ignore a particular line of code, simply append an inline pragma: allowlist secret comment. For example:
+```python
API_KEY = "blah-blah-but-actually-not-secret" # pragma: allowlist secret
print('hello world')
+```
Inline commenting syntax for a multitude of languages is supported:
--
GitLab