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

Add doc linting to CI #276

Closed
vyasr opened this issue Mar 25, 2020 · 2 comments · Fixed by #280
Closed

Add doc linting to CI #276

vyasr opened this issue Mar 25, 2020 · 2 comments · Fixed by #280
Assignees
Labels
documentation Writing or editing documentation enhancement New feature or request

Comments

@vyasr
Copy link
Contributor

vyasr commented Mar 25, 2020

Feature description

Replicate glotzerlab/signac#294 for this repo. Pick some file as a starting point (we used jsondict.py in signac) and go from there.

Proposed solution

Use pydocstyle as described in the corresponding signac issue.

@kidrahahjo
Copy link
Collaborator

@vyasr I'd like to work on this one, can you please assign me this?

@vyasr
Copy link
Contributor Author

vyasr commented Mar 31, 2020

Sure! @kidrahahjo have a close look at glotzerlab/signac#294, it should provide the exact blueprint for what you need. Similar to that one, you'll want to pick one file (preferably a smaller one, not something like flow/project.py) and apply pydocstyle to it. Let me know if you have any questions.

@vyasr vyasr added documentation Writing or editing documentation enhancement New feature or request labels Mar 31, 2020
@kidrahahjo kidrahahjo mentioned this issue Apr 1, 2020
12 tasks
@vyasr vyasr closed this as completed in #280 Apr 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Writing or editing documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants