diff options
| author | Adam Janovsky | 2024-02-20 10:17:26 +0100 |
|---|---|---|
| committer | Adam Janovsky | 2024-02-20 10:17:26 +0100 |
| commit | cdb54b71d53e8378457822b4a95f1b3fa78b1add (patch) | |
| tree | 17284715b74fb082ae81b5848e0d7e8e97a2c361 | |
| parent | 80d60885e4e424f15860e30405addc165e30f009 (diff) | |
| download | sec-certs-cdb54b71d53e8378457822b4a95f1b3fa78b1add.tar.gz sec-certs-cdb54b71d53e8378457822b4a95f1b3fa78b1add.tar.zst sec-certs-cdb54b71d53e8378457822b4a95f1b3fa78b1add.zip | |
fix docs
| -rw-r--r-- | docs/api/model.md | 8 | ||||
| -rw-r--r-- | docs/configuration.md | 7 |
2 files changed, 5 insertions, 10 deletions
diff --git a/docs/api/model.md b/docs/api/model.md index 329e92cf..ba8ca387 100644 --- a/docs/api/model.md +++ b/docs/api/model.md @@ -9,12 +9,6 @@ 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 ```{eval-rst} @@ -45,4 +39,4 @@ However, come CVEs are missed due to omitted vulnerable configurations in [CVEDa .. currentmodule:: sec_certs.model .. autoclass:: TransitiveVulnerabilityFinder :members: -```
\ No newline at end of file +``` diff --git a/docs/configuration.md b/docs/configuration.md index dcf2b8d8..898bb0e9 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -44,11 +44,12 @@ import typing type_hints = typing.get_type_hints(Configuration) text = "" -for field, value in config.__fields__.items(): +for field, value in config.model_fields.items(): text += f"`{field}`\n\n" text += f"- type: `{type_hints[field]}`\n" text += f"- default: `{value.default}`\n" - text += f"- description: {value.field_info.description}\n" - text += f"- env name: `{list(value.field_info.extra['env_names'])[0]}`\n\n" + text += f"- description: {value.description}\n" + env_var = "SECCERTS_" + field.upper() + text += f"- env name: `{env_var}`\n\n" glue("text", Markdown(text)) ``` |