Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Verify module docstrings are up to date. #14

Open
2 tasks
zahodi opened this issue Jun 17, 2017 · 0 comments
Open
2 tasks

Verify module docstrings are up to date. #14

zahodi opened this issue Jun 17, 2017 · 0 comments

Comments

@zahodi
Copy link
Owner

zahodi commented Jun 17, 2017

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'"
@zahodi zahodi changed the title Verify module READMEs are up to date. Verify module docstrings are up to date. Jun 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant