Skip to content

Commit 3bf57fd

Browse files
committed
Imporve and correct wording for "Add A Post-Scan Plugin" page #1586
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 01fb718 commit 3bf57fd

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

docs/source/tutorials/how_to_add_a_post_scan_plugin.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ installation of ScanCode. The code for this sort of plugin is located here::
8282

8383
https://github.com/aboutcode-org/scancode-plugins
8484

85-
This wiki page will focus on optional post-scan plugins.
85+
This page will focus on optional post-scan plugins.
8686

8787
Example Post-Scan Plugin: Hello ScanCode
8888
----------------------------------------
@@ -256,7 +256,7 @@ Imports
256256
Create a ``PostScanPlugin`` class
257257
"""""""""""""""""""""""""""""""""
258258

259-
The ``PostScanPlugin`` class
259+
The ``PostScanPlugin`` class (see
260260
`PostScanPlugin code <https://github.com/nexB/plugincode/blob/main/src/plugincode/post_scan.py>`_)
261261
inherits from the ``CodebasePlugin`` class (see
262262
`CodebasePlugin code <https://github.com/nexB/plugincode/blob/main/src/plugincode/__init__.py>`_),
@@ -294,8 +294,11 @@ which inherits from the ``BasePlugin`` class (see
294294
Load the plugin
295295
---------------
296296

297-
- To load and use the plugin in the normal course, navigate to the plugin's root folder (in this
298-
example: ``/plugins/scancode-hello/``) and run ``pip install .`` (don't forget the final ``.``).
297+
- Esure the ScanCode-Toolkit's virtual environment ``(venv)`` is activated.
298+
299+
- Navigate to the plugin's root folder (in this example:
300+
``/scancode-plugins/misc/scancode-hello/``) and run ``pip install .``
301+
(don't forget the final ``.``).
299302

300303
- If you're developing and want to test your work, save your edits and run ``pip install -e .``
301304
from the same folder.
@@ -304,13 +307,14 @@ Load the plugin
304307
More-complex examples
305308
---------------------
306309

307-
This Hello ScanCode example is quite simple. For examples of more-complex structures and
308-
functionalities you can take a look at the other post-scan plugins for guidance and ideas.
310+
This ``Hello ScanCode`` example is quite simple. For more complex
311+
structures and functionalities examples, you can take a look at the other
312+
post-scan plugins for guidance and ideas.
309313

310-
One good example is the License Policy post-scan plugin. This plugin is installed when ScanCode
311-
is installed and consequently is not located in the ``/plugins/`` directory used for
312-
manually-installed post-scan plugins. The code for the License Policy plugin can be found at
314+
One good example is the License Policy post-scan plugin. This is a build-in
315+
plugin. The code for the License Policy plugin can be found at
313316
`/scancode-toolkit/src/licensedcode/plugin_license_policy.py
314-
<https://github.com/aboutcode-org/scancode-toolkit/blob/develop/src/licensedcode/plugin_license_policy.py>`_
315-
and illustrates how a plugin can be used to analyze the results of a ScanCode scan using external
316-
data files and add the results of that analysis as a new field in the ScanCode JSON output file.
317+
<https://github.com/aboutcode-org/scancode-toolkit/blob/develop/src/licensedcode/plugin_license_policy.py>`_.
318+
It illustrates how a plugin can be used to analyze the results of a
319+
ScanCode scan and add the results of that analysis as a new field in the
320+
ScanCode JSON output file.

0 commit comments

Comments
 (0)