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

style guide #431

Closed
shabbychef opened this issue Feb 21, 2012 · 2 comments
Closed

style guide #431

shabbychef opened this issue Feb 21, 2012 · 2 comments
Labels
domain:docs This change adds or pertains to documentation

Comments

@shabbychef
Copy link
Contributor

Having a general style guide in place before the code base grows might prevent headaches in the future. Such a style guide should include best practices on documenting the help for a function. (Perhaps this is a separate issue in its own right, since documentation should be usable in multiple contexts--at the repl, generated into a web page, etc.)

@JeffBezanson
Copy link
Sponsor Member

Style guide is a good idea.
Currently we're keeping function help in the reference section of the manual, and it is available in the repl via the help() function (we download and parse the markdown). Not fancy, but works.

@StefanKarpinski
Copy link
Sponsor Member

I still prefer two-space indentation.

[ducks]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

3 participants