Skip to content

Commit 70c6c56

Browse files
committed
Add suggestions from Glenn's review
1 parent c8bc24b commit 70c6c56

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ You can leverage this library in your automation framework to process circuit ma
4040
3. Each `Provider` uses one or more `Processors` that will be used to build `Maintenances` when the `Provider.get_maintenances(data)` method is called.
4141
4. Each `Processor` class uses one or more `Parsers` to process each type of data that it handles. It can have custom logic to combine the parsed data from multiple `Parsers` to create the final `Maintenance` object.
4242
5. Each `Parser` class supports one or a set of related data types, and implements the `Parser.parse()` method used to retrieve a `Dict` with the relevant keys/values.
43-
6. When calling the `Provider.get_maintenances(data)`, the `data` argument is an instance of `NotificationData` that will be used by the corresponding `Parser` when the `Processor` will try to match them.
4443

4544
<p align="center">
4645
<img src="https://raw.githubusercontent.com/nautobot/nautobot-plugin-circuit-maintenance/develop/docs/images/new_workflow.png" width="800" class="center">
@@ -227,7 +226,7 @@ from bs4.element import ResultSet # type: ignore
227226
from circuit_maintenance_parser.parser import Html
228227

229228
class HtmlParserABCDE1(Html):
230-
def parse_html(self, soup) -> Dict:
229+
def parse_html(self, soup: ResultSet) -> Dict:
231230
data = {}
232231
self._parse_bs(soup.find_all("b"), data)
233232
self._parse_tables(soup.find_all("table"), data)

0 commit comments

Comments
 (0)