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

Update documentation #12

Merged
merged 3 commits into from
Oct 12, 2020
Merged

Conversation

grimmmyshini
Copy link
Collaborator

@grimmmyshini grimmmyshini commented Oct 11, 2020

Description

Update documentation to add minimal information.

Fixes: #13

Type of change

  • New feature (non-breaking change which adds functionality)

Checklist:

  • I have optimized the import, on pycharm it can be done using ctrl + alt/option + o
  • I have used Black for Code Formatting, this enhances code readability.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Any dependent changes have been merged and published in downstream modules

NOTE

Please assign @ramanaditya or other maintainers for code review.

@grimmmyshini grimmmyshini reopened this Oct 11, 2020
@grimmmyshini grimmmyshini changed the base branch from main to develop October 11, 2020 19:54
@grimmmyshini grimmmyshini added documentation Improvements or additions to documentation low-priority Low Priority Tasks labels Oct 12, 2020
docs/source/contributors.rst Outdated Show resolved Hide resolved
@ramanaditya ramanaditya merged commit 4579a32 into MLH-Fellowship:develop Oct 12, 2020
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 low-priority Low Priority Tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants