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

Improve documentation #286

Merged
merged 16 commits into from
Apr 19, 2021
Merged

Improve documentation #286

merged 16 commits into from
Apr 19, 2021

Conversation

SabineHaas
Copy link
Collaborator

@SabineHaas SabineHaas commented Apr 14, 2021

Fix #163, #159

Changes proposed in this pull request:

  • Introduce section "local energy system" in Model assumptions in RTD
  • Add basic model assumptions to RTD
  • Add headings in parameters.rst to make references of these sections possible in RTD
  • Improve "scope and limitations" section of RTD with additional information and corrections
  • Minor changes in README.rst

The following steps were realized, as well (required):

  • Update the CHANGELOG.md
  • ❌ Check if full simulation tests pass locally (EXECUTE_TESTS_ON=master pytest)

Also the following steps were realized (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

Please mark above checkboxes as following:

  • Open
  • Done

In case of an error due to linting, run black . --exclude docs/ and push your changes.
Note that in case you do not fix a whole issue you should start your PR with Address #xyz.

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

@SabineHaas SabineHaas self-assigned this Apr 14, 2021
@SabineHaas SabineHaas marked this pull request as ready for review April 14, 2021 11:23
@SabineHaas SabineHaas changed the title Addional model assumptions in RTD Improve documentation Apr 15, 2021
@SabineHaas
Copy link
Collaborator Author

@MaGering I've included some more changes in the same PR so that it's easier to review;)

README.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@MaGering MaGering left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for improving the docs! :) There are a few typos I found during the review. The content looks good to me!

A typo in README.rst in line 74 / 75 that I couldn't correct in review mode. It should be:

You can download the open source [...]

README.rst Outdated Show resolved Hide resolved
docs/model_assumptions.rst Outdated Show resolved Hide resolved
docs/model_assumptions.rst Outdated Show resolved Hide resolved
docs/model_assumptions.rst Outdated Show resolved Hide resolved
docs/parameters.rst Show resolved Hide resolved
docs/scope_limits.rst Outdated Show resolved Hide resolved
docs/scope_limits.rst Outdated Show resolved Hide resolved
docs/scope_limits.rst Outdated Show resolved Hide resolved
docs/scope_limits.rst Outdated Show resolved Hide resolved
docs/scope_limits.rst Outdated Show resolved Hide resolved
SabineHaas and others added 3 commits April 19, 2021 12:01
@SabineHaas
Copy link
Collaborator Author

Thank you for improving the docs! :) There are a few typos I found during the review. The content looks good to me!

Thank you @MaGering for correcting the typos and some expressions :)

A typo in README.rst in line 74 / 75 that I couldn't correct in review mode. It should be:

You can download the open source [...]

done with bdafd38

@SabineHaas SabineHaas merged commit 50c4740 into dev Apr 19, 2021
@SabineHaas SabineHaas deleted the feature/documentation_issue_163 branch April 19, 2021 10:17
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.

[documentation] add model assumptions
2 participants