fix(docs): clarify that the raw JSON export does not include the summary

AnLuChun · Feb 23, 2022 · 64f0a12 · 64f0a12
1 parent 6f54f68
commit 64f0a12
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/commandline.rst b/docs/commandline.rst
@@ -390,7 +390,8 @@ Options
 
 .. option:: -j, --json
 
-   If given, the results will be converted into JSON.
+   If given, the results will be converted into JSON. Note that the JSON export
+   does not include the summary (enabled with the option `-s, --summary`).
 
 .. option:: -O, --output-file
 

diff --git a/radon/cli/__init__.py b/radon/cli/__init__.py
@@ -171,7 +171,8 @@ def raw(
         hidden directories (starting with '.') are ignored.
     :param -s, --summary:  If given, at the end of the analysis display the
         summary of the gathered metrics. Default to False.
-    :param -j, --json: Format results in JSON.
+    :param -j, --json: Format results in JSON. Note that the JSON export does
+        not include the summary (enabled with `-s, --summary`).
     :param -O, --output-file <str>: The output file (default to stdout).
     :param --include-ipynb: Include IPython Notebook files
     :param --ipynb-cells: Include reports for individual IPYNB cells