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

Enhance documentation, add small fixes and information #155

Merged
merged 11 commits into from
Dec 8, 2020

Conversation

SabineHaas
Copy link
Collaborator

@SabineHaas SabineHaas commented Dec 3, 2020

Address #154

You can check it out here: https://pvcompare.readthedocs.io/en/docs-enhancing_documentation/index.html

Changes proposed in this pull request:

The following steps were realized, as well (if applies):
❌ Use in-line comments to explain your code
❌ Write docstrings to your code
❌ For new functionalities: Explain in readthedocs
❌ Write test(s) for your new patch of code

  • ❌ Update the CHANGELOG.md (let's start this after the first release)
    ❌ Apply black (black . --exclude docs/)

Please mark above checkboxes as following:

  • Open
  • Done

❌ Check not applicable to this PR

For more information on how to contribute check the CONTRIBUTING.md.

@SabineHaas SabineHaas self-assigned this Dec 3, 2020
@SabineHaas SabineHaas requested a review from Piranias December 3, 2020 16:27
docs/about.rst Outdated Show resolved Hide resolved
@SabineHaas SabineHaas merged commit 16acbdc into dev Dec 8, 2020
@SabineHaas SabineHaas deleted the docs/enhancing_documentation branch December 8, 2020 10:24
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.

2 participants