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.

Sign up for GitHub

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

Jump to bottom

Docstrings #51

Open
ax3l opened this issue May 10, 2016 · 2 comments
Open

Docstrings #51

ax3l opened this issue May 10, 2016 · 2 comments
Labels
documentation enhancement high priority
Milestone
v1.0

Comments

@ax3l
Copy link
Contributor

ax3l commented May 10, 2016 •
edited
Loading

Argh, I really wish methods in classes like plotting.plottercls would have doc-strings ;)

No seriously, we need more doc strings on every object and member function ✨
@skuschel
Copy link
Owner

Yes absolutely right! However -- the plotter class seems lowest priority since Its internal design is pretty bad. I would like to have something which can work with jupyter notebooks as well. For everything else I agree on the imortance, but havent had much time for that yet.

@ax3l
Copy link
Contributor Author

ax3l commented May 12, 2016

Yes, the issue actually more about using Docstring in general for any public API :)

@skuschel skuschel added this to the v1.0 milestone Nov 10, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement high priority
Projects
None yet
Milestone
v1.0
Development

No branches or pull requests
2 participants
@ax3l @skuschel