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.

Sign up for GitHub

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

Jump to bottom

Improve docs #58

Open
threewisemonkeys-as opened this issue Jul 17, 2020 · 1 comment
Open

Improve docs #58

threewisemonkeys-as opened this issue Jul 17, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@threewisemonkeys-as
Copy link
Contributor

  1. Organise docs into logical sections
  2. Add intro text
  3. Add examples
  4. Fix minor formatting issues in docstrings (good first issue)

We are using this style guide
@threewisemonkeys-as threewisemonkeys-as added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 17, 2020
@threewisemonkeys-as
Copy link
Contributor Author

Point 1 and 2 have been sufficiently covered for now. Examples will be part of #36 and #35 anyways. So major point here is 4. A lot of docstrings arent well formatted as of now so that needs ot be corrected so the docs become better

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@threewisemonkeys-as