Skip to content

Commit

Permalink
doc: fix some grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
AnakinRaW authored and janniclas committed Aug 20, 2024
1 parent 6556709 commit f6f314e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/SPHA.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document is meant to give a general overview of the library's functionality

A tool adapter transforms the given tool results into *RawValueKPIs*. This functionality is
defined by the `interface KpiAdapter<T>`. We support two kind of adapters *tools* and *kpis*.
*Tool* adapter take a tool result as an input and transform it into, possibly multiple, KPIs.
*Tool* adapters take a tool's result as an input and transform it into, possibly multiple, KPIs.
A *tool* adapter might use one or multiple *kpi* adapter to do this transformation.<p>
The reasoning behind this design is, that one tool might produce multiple different KPIs.
E.g., the OSS review toolkit (ORT) produces information about vulnerabilities, licences,
Expand All @@ -26,7 +26,7 @@ It is implemented as a graph in which each node defines a `KpiId`, which is used
which KPI belongs to the node, as well as a list of children. Further, the node stores a `StrategyId`,
which relates to a `CalculationStrategy`. The `CalculationStrategy` defines how each node processes the data stored in
its children. The `KpiId` has no influence on the semantic processing of the KPI hierarchy. For more information
regarding the calculation see ![Kpi Calculation](#kpi-calculation).
regarding the calculation see [Kpi Calculation](#kpi-calculation).

Additionally, we define a `KpiResultHierarchy`, which stores the same information as the regular `KpiHierarchy` as well
as a `KpiCalculationResult`.
Expand All @@ -51,4 +51,4 @@ objects can be generated using the ![Adapters](#tool-adapter). The calculation i
node and the `RawValueKpi`. Whenever there is a match the value of the KPI is attached to the node.
2. We calculate the `KpiCalculationResult` results by applying the `CalculationStrategy` on each node. The strategies
are applied depth-first order. This is important, as we must start our calculation at the leaf nodes and work our
way up the tree to the root.
way up the tree to the root.

0 comments on commit f6f314e

Please sign in to comment.