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

Uncomplete Documentation Strings (Docstrings) #32

Open
guillaume-chevalier opened this issue Aug 8, 2019 · 6 comments

Comments

@guillaume-chevalier
Copy link
Member

commented Aug 8, 2019

Many classes have incomplete docstring. Sometimes, there are also typos.

The docstrings in classes are used with the sphinx documentation builder to build the website's complete documentation API:
https://www.neuraxle.neuraxio.com/stable/api.html

@guillaume-chevalier

This comment has been minimized.

Copy link
Member Author

commented Aug 8, 2019

I'd love to have your help with that @kaddynator !

@kaddynator

This comment has been minimized.

Copy link

commented Aug 8, 2019

Sure, I will have a look at that during this weekend.

@guillaume-chevalier

This comment has been minimized.

Copy link
Member Author

commented Aug 10, 2019

Cool!

@gam271

This comment has been minimized.

Copy link

commented Aug 16, 2019

Do you still need help? I'd love to contribute

@guillaume-chevalier

This comment has been minimized.

Copy link
Member Author

commented Aug 16, 2019

@gam271 Contributors are welcomed! There are lots of things to do for sure :)

@kaddynator What's up, have you taken already some files or classes?

By the way, the docstring's style to be used to render the website is reStructeredText. For example, that's the default style setting in PyCharm when you open three """ on the first line of a function and press enter. Sphinx is used to render the site so there is extra syntax that's possible to use in the docstrings.

@kaddynator

This comment has been minimized.

Copy link

commented Aug 17, 2019

Hi, @guillaume-chevalier I was checking the doc of Sphinx. I was reading through the tutorial and some of the common styles that are used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.