aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAdam Janovsky2022-07-25 20:45:11 +0200
committerAdam Janovsky2022-07-25 20:45:11 +0200
commit2961284371d2e9aae3854af3fc2fee28ba1983b7 (patch)
tree13c964876b77723bfe2cfda6b56dc0aeb024a425
parentc51ebf5c3052a0642701a3feeefe2130e8fed5e6 (diff)
downloadsec-certs-2961284371d2e9aae3854af3fc2fee28ba1983b7.tar.gz
sec-certs-2961284371d2e9aae3854af3fc2fee28ba1983b7.tar.zst
sec-certs-2961284371d2e9aae3854af3fc2fee28ba1983b7.zip
update docs: reference missed CVEs
-rw-r--r--docs/api/model.md8
-rw-r--r--docs/index.md1
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/api/model.md b/docs/api/model.md
index 406d24be..1e48315d 100644
--- a/docs/api/model.md
+++ b/docs/api/model.md
@@ -9,6 +9,14 @@
The examples related to this package can be found at [model notebook](./../notebooks/examples/model.ipynb).
```
+```{warning}
+Transforming `CPE` records to existing vulnerabilities is handled by [Dataset](https://github.com/crocs-muni/sec-certs/blob/main/sec_certs/dataset/dataset.py) class, `compute_related_cves()` method.
+
+However, come CVEs are missed due to omitted vulnerable configurations in [CVEDataset](https://github.com/crocs-muni/sec-certs/blob/main/sec_certs/dataset/cve.py) class. We omit configurations that comprise of two components joined with `AND` operator. For closer description, see [issue #252](https://github.com/crocs-muni/sec-certs/issues/252) at GitHub.
+
+`CPEClassifier` currently ignores
+```
+
## CPEClassifier
```{eval-rst}
diff --git a/docs/index.md b/docs/index.md
index 4760ed1c..e99208c0 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -31,7 +31,6 @@ Seccerts PyPi <https://pypi.org/project/sec-certs/>
:maxdepth: 1
installation.md
quickstart.md
-tutorial.md
configuration.md
```