aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
authorJ08nY2024-10-19 12:06:31 +0200
committerJ08nY2024-10-19 12:06:31 +0200
commit8e0f9dcc1eb3fafa6d446e9db44191b447e6dc78 (patch)
tree06b3f3f9171c20ec240785f095f470b728ddf760 /src
parent4325e46f96f29e95acdc2a11943150ee089edd55 (diff)
downloadsec-certs-8e0f9dcc1eb3fafa6d446e9db44191b447e6dc78.tar.gz
sec-certs-8e0f9dcc1eb3fafa6d446e9db44191b447e6dc78.tar.zst
sec-certs-8e0f9dcc1eb3fafa6d446e9db44191b447e6dc78.zip
Cleanup of documentation.
It is now very nice and clean!
Diffstat (limited to 'src')
-rw-r--r--src/sec_certs/dataset/cc.py5
-rw-r--r--src/sec_certs/dataset/dataset.py5
-rw-r--r--src/sec_certs/dataset/fips.py5
-rw-r--r--src/sec_certs/sample/cc.py5
4 files changed, 9 insertions, 11 deletions
diff --git a/src/sec_certs/dataset/cc.py b/src/sec_certs/dataset/cc.py
index 4c1114f3..ba2ffb58 100644
--- a/src/sec_certs/dataset/cc.py
+++ b/src/sec_certs/dataset/cc.py
@@ -269,9 +269,8 @@ class CCDataset(Dataset[CCCertificate, CCAuxiliaryDatasets], ComplexSerializable
Optionally stores it at the given path (a directory) and also downloads auxiliary datasets and artifacts (PDFs).
- :::{note}
- Note that including the auxiliary datasets adds several gigabytes and including artifacts adds tens of gigabytes.
- :::
+ .. note::
+ Note that including the auxiliary datasets adds several gigabytes and including artifacts adds tens of gigabytes.
:param path: Path to a directory where to store the dataset, or `None` if it should not be stored.
:param auxiliary_datasets: Whether to also download auxiliary datasets (CVE, CPE, CPEMatch datasets).
diff --git a/src/sec_certs/dataset/dataset.py b/src/sec_certs/dataset/dataset.py
index 44b390c8..c906fd59 100644
--- a/src/sec_certs/dataset/dataset.py
+++ b/src/sec_certs/dataset/dataset.py
@@ -193,9 +193,8 @@ class Dataset(Generic[CertSubType, AuxiliaryDatasetsSubType], ComplexSerializabl
Optionally stores it at the given path (a directory) and also downloads auxiliary datasets and artifacts (PDFs).
- :::{note}
- Note that including the auxiliary datasets adds several gigabytes and including artifacts adds tens of gigabytes.
- :::
+ .. note::
+ Note that including the auxiliary datasets adds several gigabytes and including artifacts adds tens of gigabytes.
:param archive_url: The URL of the full dataset archive.
:param snapshot_url: The URL of the full dataset snapshot.
diff --git a/src/sec_certs/dataset/fips.py b/src/sec_certs/dataset/fips.py
index eeaec0a0..0feb920f 100644
--- a/src/sec_certs/dataset/fips.py
+++ b/src/sec_certs/dataset/fips.py
@@ -228,9 +228,8 @@ class FIPSDataset(Dataset[FIPSCertificate, FIPSAuxiliaryDatasets], ComplexSerial
Optionally stores it at the given path (a directory) and also downloads auxiliary datasets and artifacts (PDFs).
- :::{note}
- Note that including the auxiliary datasets adds several gigabytes and including artifacts adds tens of gigabytes.
- :::
+ .. note::
+ Note that including the auxiliary datasets adds several gigabytes and including artifacts adds tens of gigabytes.
:param path: Path to a directory where to store the dataset, or `None` if it should not be stored.
:param auxiliary_datasets: Whether to also download auxiliary datasets (CVE, CPE, CPEMatch datasets).
diff --git a/src/sec_certs/sample/cc.py b/src/sec_certs/sample/cc.py
index aa145706..63c2cca5 100644
--- a/src/sec_certs/sample/cc.py
+++ b/src/sec_certs/sample/cc.py
@@ -484,7 +484,8 @@ class CCCertificate(
@property
def actual_sars(self) -> set[SAR] | None:
"""
- Computes actual SARs. First, SARs implied by EAL are computed. Then, these are augmented with heuristically extracted SARs
+ Computes actual SARs. First, SARs implied by EAL are computed. Then, these are augmented with heuristically extracted SARs.
+
:return Optional[Set[SAR]]: Set of actual SARs of a certificate, None if empty
"""
sars = {}
@@ -543,7 +544,7 @@ class CCCertificate(
def merge(self, other: CCCertificate, other_source: str | None = None) -> None:
"""
Merges with other CC sample. Assuming they come from different sources, e.g., csv and html.
- Assuming that html source has better protection profiles, they overwrite CSV info
+ Assuming that html source has better protection profiles, they overwrite CSV info.
On other values the sanity checks are made.
"""
if self != other: