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

Conventions on documenting a function #9491

Closed
chrisvoncsefalvay opened this issue Dec 29, 2014 · 2 comments
Closed

Conventions on documenting a function #9491

chrisvoncsefalvay opened this issue Dec 29, 2014 · 2 comments

Comments

@chrisvoncsefalvay
Copy link

(I've made a good faith effort to find anything relevant on this but didn't - I apologise if I overlooked something, please feel free to point me to the original post if I'm about to reinvent the wheel here)

I was wondering if there were a convention on the content and structure of the docstring for functions. Consider, for instance, PEP257 in Python. Is there something equivalent for Julia? I've been a little surprised by how little documentation some functions have (when compared to e.g. Python - I appreciate this is an unfair comparison) and thought I'd help out by seeing if I could start documenting a few, but I don't want to do so without knowing the right way to declare arguments and their types, etc.

Thanks!

@elextr
Copy link

elextr commented Dec 29, 2014

IIUC its just starting to be defined, see #9447

@mbauman
Copy link
Member

mbauman commented Dec 29, 2014

This is a dup of #8966.

@jiahao jiahao closed this as completed Dec 29, 2014
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

4 participants