Skip to content

Docstandard #61

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
wants to merge 4 commits into from
Closed

Docstandard #61

wants to merge 4 commits into from

Conversation

rgommers
Copy link
Member

Some changes to the docstandard. Closes tickets 1165, 1280, 1501, 1509 and 1524.

For the deprecation section I chose to use the note directive instead of the deprecated directive, because the latter does not seem to work well with the docstring parsing machinery. It concatenates summary line, deprecation message and extended summary.

@mwiebe
Copy link
Member

mwiebe commented Mar 25, 2011

The text all looks fine to me.

@pv
Copy link
Member

pv commented Mar 29, 2011

Some commends: "If references are not referred to in the docstring text, the numbering can be omitted."
However, then they don't follow the RST bibliography format, which might be useful to stick with.

The module docstring part might need some revision in the future -- I think a reasonable aim is to move the sphinx module docs to the module docstrings.

@rgommers
Copy link
Member Author

I was just documenting there what has been done recently, mainly by David G.. I'm fine with leaving off the sentence "If references are not referred to in the docstring text, the numbering can be omitted." and putting back numbering everywhere.

I like the moving module docstrings idea too; never saw the point of the info.py files. But I think that should not prevent committing the current edits, it's more or less an orthogonal issue.

@pv
Copy link
Member

pv commented Mar 29, 2011

I think the edits are OK to go in. The module issue can be addressed later on.

@rgommers
Copy link
Member Author

OK, committed.

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

Successfully merging this pull request may close these issues.

3 participants