Skip to content

Commit

Permalink
Update docs/dev/dev_config.md
Browse files Browse the repository at this point in the history
Co-authored-by: Adam Byczkowski <38091261+qduk@users.noreply.github.com>
  • Loading branch information
itdependsnetworks and qduk committed Sep 8, 2023
1 parent 7469b64 commit 5560ec9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/dev/dev_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ There are a series of considerations documented below, when developing a new par
- Add to `netutils/config/compliance.py` the `parser_map`, that maps the name of the parser to the Plugin.
- Ensure that the key name is based on `netutils.lib_mapper.MAIN_LIB_MAPPER_LIB_MAPPER` definitions.
- Ensure that it is alpha sorted.
- Ensure that it the key is added to `netutils.lib_mapper.NETUTILSPARSER_LIB_MAPPER` and `netutils.lib_mapper.NETUTILSPARSER_LIB_MAPPER_REVERSE`.
- Ensure that the key is added to `netutils.lib_mapper.NETUTILSPARSER_LIB_MAPPER` and `netutils.lib_mapper.NETUTILSPARSER_LIB_MAPPER_REVERSE`.
- Fill out docstrings in the class and methods within the class that describe the parameters and an Example that compiles.
- The following tips will generally be applicable.
- Generally a class method should provide a `comment_chars` and `banner_start` as well as sometimes `banner_end`.
Expand Down

0 comments on commit 5560ec9

Please sign in to comment.