Skip to content

Commit fe7d780

Browse files
author
Trong Nhan Mai
committed
chore: fix grammar errors in the Sphinx documentation
Signed-off-by: Trong Nhan Mai <[email protected]>
1 parent 874f964 commit fe7d780

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/source/pages/output_files.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ For more information on the three fields ``type``, ``namespace`` and ``name`` of
5454
Typically, when a repository path is provided as the main software component of the :ref:`analyze action <analyze-action-cli>`,
5555
a PURL is generated from the repository path, which is then later used in generating the unique report path.
5656

57-
For example, when run this command:
57+
For example, when running this command:
5858

5959
.. code-block::
6060

docs/source/pages/using.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,19 +120,19 @@ The list bellow shows examples for the corresponding PURL string for different g
120120
* - ``https://gitlab.com/gitlab-org/gitlab``
121121
- ``pkg:gitlab.com/gitlab-org/gitlab``
122122

123-
After the PURL string has been obtained, the analysis could be run with:
123+
After the PURL string has been obtained, the analysis can be run with:
124124

125125
.. code-block:: shell
126126
127127
./run_macaron.sh analyze -purl <purl_string>
128128
129-
You can also provide the PURL string together with the repository path. In this case, the PURL string will be used as the unique identifier to the analysis target:
129+
You can also provide the PURL string together with the repository path. In this case, the PURL string will be used as the unique identifier for the analysis target:
130130

131131
.. code-block:: shell
132132
133133
./run_macaron.sh analyze -purl <purl_string> -rp <repo_path> -b <branch> -d <digest>
134134
135-
.. note:: When provide the PURL and the repository path, both branch name and commit digest must be provided as well.
135+
.. note:: When providing the PURL and the repository path, both the branch name and commit digest must be provided as well.
136136

137137
-------------------------------------------------
138138
Verifying provenance expectations in CUE language
@@ -262,7 +262,7 @@ Running the policy engine
262262
Macaron's policy engine accepts policies specified in `Datalog <https://en.wikipedia.org/wiki/Datalog>`_. An example policy
263263
can verify if a project and all its dependencies pass certain checks. We use `Soufflé <https://souffle-lang.github.io/index.html>`_
264264
as the Datalog engine in Macaron. Once you run the checks on a target project as described :ref:`here <analyze-action>`,
265-
the check results will be stored in ``macaron.db`` in the output directory. Because the check results of different software component can be stored into the database at ``macaron.db``, we must specify the target software component in the Datalog policy file to be enforced by the policy engine. There are two ways that we could
265+
the check results will be stored in ``macaron.db`` in the output directory. Because the check results of different software components can be stored in the database at ``macaron.db``, we must specify the target software component in the Datalog policy file to be enforced by the policy engine. There are two ways that we can
266266
specify the target software component in the Datalog policy file:
267267

268268
#. Using the complete name of the target component (e.g. ``github.com/oracle-quickstart/oci-micronaut``)
@@ -298,7 +298,7 @@ The differences between the two policy files can be observed below:
298298

299299
apply_policy_to("oci_micronaut_dependencies", component_id) :- is_component(component_id, "<target_software_component_purl>").
300300

301-
The PURL string for the target software component could be obtained when the :ref:`analyze command <analyze-action>` finishes. For example:
301+
The PURL string for the target software component can be obtained when the :ref:`analyze command <analyze-action>` has finished. For example:
302302

303303
.. code:: shell
304304

0 commit comments

Comments
 (0)