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

[WIP] nice docs #26

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

[WIP] nice docs #26

wants to merge 1 commit into from

Conversation

mfekadu
Copy link
Member

@mfekadu mfekadu commented Jan 31, 2020

accidental pull request while creating a PR template... will describe this better soon...

What's New?

Please include a summary of the change and which issue is fixed.
Please also include relevant motivation and context.
List any dependencies that are required for this change.

Fixes #<<ISSUE_NUMBER>> ... (e.g. #9)

Type of change (pick-one)

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.
Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration

Checklist (check-all-before-merge)

formatting help: - [x] means "checked' and - [ ] means "unchecked"

  • I added my tests to the /tests directory

  • I documented my code according to the Google Python Style Guide

  • I ran ./run_tests.sh and all the tests pass

  • I ran ./format.sh because it automatically cleans my code for me 😄

  • I ran ./lint.sh to check for what "format" missed

  • I ran ./type_check.sh and got no errors

  • I ran ./build_docs.sh and the docs look fine

@mfekadu mfekadu changed the title nice docs [WIP] nice docs Jan 31, 2020
This was referenced Mar 5, 2020
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

Successfully merging this pull request may close these issues.

1 participant