Skip to content

Commit 9881d3c

Browse files
committed
Check Sphinx syntax and formatting and correct as needed
Signed-off-by: John M. Horan <[email protected]>
1 parent d0dd5b3 commit 9881d3c

File tree

4 files changed

+16
-17
lines changed

4 files changed

+16
-17
lines changed

docs/source/importers_link.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
Importers
44
=========
55

6-
.. include:: ../../SOURCES.rst
6+
.. include:: ../../SOURCES.rst

docs/source/reference_importer_overview.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Importer Overview
44
==================
55

6-
Importers are responsible for scraping vulnerability data such as vulnerabilities and their fixes and
7-
for storing the scraped information in a structured fashion. The structured data created by the
6+
Importers are responsible for scraping vulnerability data such as vulnerabilities and their fixes
7+
and for storing the scraped information in a structured fashion. The structured data created by the
88
importer then provides input to an improver (see :ref:`improver-overview`), which is responsible
99
for creating a relational model for vulnerabilities, affected packages and fixed packages.
1010

docs/source/tutorial_add_new_importer.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ implementing the unimplemented methods.
9090
Specify the Importer License
9191
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9292

93-
Importers scrape data off the internet. In order to make sure the data is useable, a license must be
94-
provided.
93+
Importers scrape data off the internet. In order to make sure the data is useable, a license
94+
must be provided.
9595
Populate the ``spdx_license_expression`` with the appropriate value.
9696
The SPDX license identifiers can be found at https://spdx.org/licenses/.
9797

@@ -102,10 +102,10 @@ The SPDX license identifiers can be found at https://spdx.org/licenses/.
102102
Implement the ``advisory_data`` Method
103103
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
104104

105-
The ``advisory_data`` method scrapes the advisories from the data source this importer is targeted
106-
at.
107-
It is required to return an *Iterable of AdvisoryData objects*, and thus it is a good idea to yield from
108-
this method after creating each AdvisoryData object.
105+
The ``advisory_data`` method scrapes the advisories from the data source this importer is
106+
targeted at.
107+
It is required to return an *Iterable of AdvisoryData objects*, and thus it is a good idea to yield
108+
from this method after creating each AdvisoryData object.
109109

110110
At this point, an example importer will look like this:
111111

docs/source/tutorial_add_new_improver.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,9 @@ Writing an improver
6868
Locate the Source File
6969
^^^^^^^^^^^^^^^^^^^^^^^^
7070

71-
If the improver will be working on data imported by a specific importer, it will be located in the same
72-
file at :file:`vulnerabilites/importers/{importer-name.py}`.
73-
Otherwise, if it is a generic improver, create a new file
74-
:file:`vulnerabilites/improvers/{improver-name.py}`.
71+
If the improver will be working on data imported by a specific importer, it will be located in
72+
the same file at :file:`vulnerabilites/importers/{importer-name.py}`. Otherwise, if it is a
73+
generic improver, create a new file :file:`vulnerabilites/improvers/{improver-name.py}`.
7574

7675
Explore Package Managers (Optional)
7776
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -107,10 +106,10 @@ the ``Advisory`` QuerySet returned by the ``interesting_advisories`` property.
107106
It is expected to return an iterable of ``Inference`` objects for the given ``AdvisoryData``. To
108107
avoid storing a lot of Inferences in memory, it is preferable to yield from this method.
109108

110-
A very simple Improver that processes all Advisories to create the minimal relationships that can be
111-
obtained by existing data can be found at :file:`vulnerabilites/improvers/default.py`, which is an
112-
example of a generic improver. For a more sophisticated and targeted example, you can look at an already
113-
implemented improver (e.g., :file:`vulnerabilites/importers/nginx.py`).
109+
A very simple Improver that processes all Advisories to create the minimal relationships that can
110+
be obtained by existing data can be found at :file:`vulnerabilites/improvers/default.py`, which is
111+
an example of a generic improver. For a more sophisticated and targeted example, you can look
112+
at an already implemented improver (e.g., :file:`vulnerabilites/importers/nginx.py`).
114113

115114
Improvers are not limited to improving discrete versions and may also improve ``aliases``.
116115
One such example, improving the importer written in the :ref:`importer tutorial

0 commit comments

Comments
 (0)