-
-
Notifications
You must be signed in to change notification settings - Fork 10.8k
doc standard for modules (Trac #1280) #1878
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
Comments
Attachment added by @rgommers on 2009-11-02: docstandard_modules.patch |
@charris wrote on 2010-04-24 I think routine listings needs to be expanded a bit. There are three things that are likely to be found in modules that aren't in functions: classes, functions, and constants. I'm not sure how these should be handled, but we need a policy and an example. |
Milestone changed to |
trac user dgoldsmith wrote on 2010-05-30 Can/should we expand this to "doc standard for modules, sub-packages, and packages," or are there things about the latter two which make them require their own standard(s)? |
@mwiebe wrote on 2011-03-25 Should this patch go into 1.6? |
Milestone changed to |
Original ticket http://projects.scipy.org/numpy/ticket/1280 on 2009-11-02 by @rgommers, assigned to @pv.
Add a description of how to document modules to HOWTO_DOCUMENT.txt.
The text was updated successfully, but these errors were encountered: