Skip to content

Commit c1c460d

Browse files
committed
Improve documentation/text
Signed-off-by: Hritik Vijay <hritikxx8@gmail.com>
1 parent 2985d25 commit c1c460d

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

vulnerabilities/improver.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import dataclasses
22
import logging
33
from typing import List
4+
from typing import Iterable
45
from typing import Optional
56
from uuid import uuid4
67

@@ -72,8 +73,11 @@ def from_advisory_data(cls, advisory_data, confidence, affected_purls, fixed_pur
7273

7374
class Improver:
7475
"""
75-
Improvers are responsible to improve the already imported data by a datasource.
76-
Inferences regarding the data could be generated based on multiple factors.
76+
Improvers are responsible to improve already imported data by an importer.
77+
An improver is required to override the ``interesting_advisories`` property method to return a
78+
QuerySet of ``Advisory`` objects. These advisories are then passed to ``get_inferences`` method
79+
which is responsible for returning an iterable of ``Inferences`` for that particular
80+
``Advisory``
7781
"""
7882

7983
@property
@@ -83,7 +87,7 @@ def interesting_advisories(self) -> QuerySet:
8387
"""
8488
raise NotImplementedError
8589

86-
def get_inferences(self, advisory_data: AdvisoryData) -> List[Inference]:
90+
def get_inferences(self, advisory_data: AdvisoryData) -> Iterable[Inference]:
8791
"""
8892
Generate and return Inferences for the given advisory data
8993
"""

vulnerabilities/management/commands/improve.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ def handle(self, *args, **options):
5656

5757
sources = options["sources"]
5858
if not sources:
59-
raise CommandError('Please provide at least one improver to run use "--all".')
59+
raise CommandError('Please provide at least one improver to run or use "--all".')
6060

6161
self.improve_data(validate_improvers(sources))
6262

0 commit comments

Comments
 (0)