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

Validate/update doc strings and README #7

Open
7 of 8 tasks
PhillSimonds opened this issue May 8, 2020 · 1 comment
Open
7 of 8 tasks

Validate/update doc strings and README #7

PhillSimonds opened this issue May 8, 2020 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@PhillSimonds
Copy link
Contributor

PhillSimonds commented May 8, 2020

The following need to be updated/written for this issue to be considered resolved:

  • README.md at root of repo
  • docs/configuration.md
  • docs/mapping_schemas.md
  • docs/validate_command.md
  • docs/ansible_command.md
  • docs/schema_command.md
  • docs/using_jsonschema_refs.md
  • Update Doc Strings
@PhillSimonds PhillSimonds added the documentation Improvements or additions to documentation label Nov 20, 2020
@PhillSimonds PhillSimonds mentioned this issue Nov 23, 2020
3 tasks
@PhillSimonds
Copy link
Contributor Author

Doc strings have been updated to adhere to pydocstyle, but there are still some instances where pydocstyle isn't catching undefined arguments or unclear input types (e.g. one of the docstrings discusses that the argument should be a string, then later it says it should be a list). I've unchecked the Update Doc Strings todo above so that we can make sure the settings for pydocstyle are set correctly, and go through the doc strings with a little more detail to ensure they are all correct.

@PhillSimonds PhillSimonds added this to the v1.0.1 Release milestone Feb 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants