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

Tests for varied docstring structure #10

Open
3 of 6 tasks
vreuter opened this issue Mar 4, 2019 · 0 comments
Open
3 of 6 tasks

Tests for varied docstring structure #10

vreuter opened this issue Mar 4, 2019 · 0 comments
Assignees
Labels

Comments

@vreuter
Copy link
Member

vreuter commented Mar 4, 2019

Parameters to vary:

  • blank space between sections and/or in trailing position
  • inclusion/exclusion of tags (combinations of tag types)
  • short/long function/class description -- also spacing
  • module level
  • example code block(s)
  • constructor docstring placement -- in __init__ or above __init__ (with class description)
@vreuter vreuter added the tests label Mar 4, 2019
@vreuter vreuter self-assigned this Mar 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant