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

Revise docstrings #45

Closed
gplssm opened this issue Jul 12, 2016 · 3 comments
Closed

Revise docstrings #45

gplssm opened this issue Jul 12, 2016 · 3 comments
Assignees
Milestone

Comments

@gplssm
Copy link
Contributor

gplssm commented Jul 12, 2016

Get all docstrings right

  • Correct sections according to style guide
  • ...
@gplssm
Copy link
Contributor Author

gplssm commented May 20, 2017

This is now the parent issue for the revision of docstring. @miguelparadacontzen takes care about structure, completeness, and formatting of docstrings and provides as much information as possible. Remaining tasks to complete docstrings will be assigned to @nesnoj and @gplssm.

Let's therefore create individual issues per file or module and keep track of them along the milestone.

@gplssm
Copy link
Contributor Author

gplssm commented Apr 4, 2018

In order to use work by @miguelparadacontzen irregardless of unfinished polishing of docstrings (i.e. #202) the branch features/clean-documentation will be merged into dev. This brings a properly building API/class documentation.
The merge had a bunch of conflicts (~30 files).

  • Remove errors/warnings during sphinx-build
  • Proof that Ding0 is running properly
  • If needed, recover removed files (i.e. pypsa_io and some .rst files)
  • Write "What's New" entry
  • Close docs related issues
  • Merge to dev

@gplssm
Copy link
Contributor Author

gplssm commented Apr 7, 2018

After renaming, ding0 runs properly. Integrity of resulting data in terms of being identical to dev branch was tested successfully on grid ids 11,45,54.

This issue will be closed because API docs build now and the long living branch features/clean-documentation is merged. There is still correction and addition of/to the docs needed as issues of the docs milestone describe these needs.

@gplssm gplssm closed this as completed Apr 7, 2018
boltbeard pushed a commit that referenced this issue May 28, 2018
boltbeard pushed a commit that referenced this issue May 28, 2018
boltbeard pushed a commit that referenced this issue May 28, 2018
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

No branches or pull requests

2 participants