Skip to content

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

Closed
thouis opened this issue Oct 19, 2012 · 8 comments
Closed

doc standard for modules (Trac #1280) #1878

thouis opened this issue Oct 19, 2012 · 8 comments

Comments

@thouis
Copy link
Contributor

thouis commented Oct 19, 2012

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.

@thouis thouis closed this as completed Oct 19, 2012
@numpy-gitbot
Copy link

Attachment added by @rgommers on 2009-11-02: docstandard_modules.patch

@numpy-gitbot
Copy link

@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.

@numpy-gitbot
Copy link

Milestone changed to Unscheduled by @rgommers on 2010-05-30

@numpy-gitbot
Copy link

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)?

@numpy-gitbot
Copy link

@mwiebe wrote on 2011-03-25

Should this patch go into 1.6?

@numpy-gitbot
Copy link

@rgommers wrote on 2011-03-25

I'm working on this, together with the other patches for the doc standard: #1763, #2121, #2098, #2106. It doesn't have to be backported to 1.6, the document in master is the only interesting one.

@numpy-gitbot
Copy link

@rgommers wrote on 2011-03-29

committed with minor changes (emphasized routine listings more in response to Charles' comment) in b11ae17

@numpy-gitbot
Copy link

Milestone changed to NumPy 2.0 by @mwiebe on 2011-05-31

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants