Skip to content

Verify module docstrings are up to date. #14

Description

@zahodi

Module docstrings need to be revised:

  • provide sufficient examples
  • identify the parameter that is used identifying idempotency. Some modules look for a name and others have to check for a comment. Firewall modules are ensured based on their order and thus we use "order number" + "comment" to identify an item. Most module should have an idempotent parameter identified in the code and we just add that to the docstrings. Example: " idempotent_parameter = 'name'"

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions