summaryrefslogtreecommitdiff
path: root/doc/HOWTO_DOCUMENT.rst.txt
Commit message (Collapse)AuthorAgeFilesLines
* DOC: Note that all imports need to be explicitendolith2015-09-011-1/+2
| | | except `np`
* MAINT: fix broken and outdated link in HOWTO_DOCUMENT. Closes gh-6107.Ralf Gommers2015-07-261-4/+0
| | | | [ci skip]
* DOC: Mention numpydoc 0.6.chebee7i2015-02-141-2/+10
|
* DOC: Replace "Parameters" with "Returns".chebee7i2015-02-141-1/+1
|
* DOC: Clarify documentation for Yields.chebee7i2015-01-111-4/+3
|
* DOC: Add documentation for Yields section in docstrings.chebee7i2015-01-111-19/+49
|
* escape the italics bold and monospace examplesendolith2014-08-261-1/+2
| | | since this is meant to be read in rendered form, and there are examples of these scattered through the text otherwise
* DOC: fix PEP links in HOWTO_DOCUMENT.rst.txtTalha Oz2014-07-271-6/+6
|
* MAINT: Update link to numpydoc READMEThomas Kluyver2014-01-071-1/+1
| | | This is the counterpart of my PR numpy/numpydoc#7 renaming the README.
* MAINT: Update links to numpydoc source code and READMEThomas Kluyver2013-11-141-3/+2
| | | These links pointed to numpydoc's location within the numpy project on Github, but it has since been split out to a separate repository, breaking the links.
* DOC: Add an example of casting array type and byte order using astype.Miguel de Val-Borro2013-11-111-2/+5
|
* STY: Giant whitespace cleanup.Charles Harris2013-08-181-16/+16
| | | | Now is as good a time as any with open PR's at a low.
* ENH: Allow unnamed return values in Returns section of doc stringRob Ruana2013-06-251-3/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | Developers usually only need the type of a return value followed by a brief description. However, in some cases providing a name for a return value can make the documentation clearer. This enhancement changes the format of the Returns section such that the type is required, and the name is optional: Returns ------- int Description of anonymous integer return value. x : str Description of string return value named `x`. With this change, if a colon is not present, then the entire line is interpreted as the return type. In all other cases, the Returns section is interpreted according to the current rules. Consistent with the current format, if a colon is present, then the text to the left of the colon is interpreted as the name; and the text to the right of the colon is interpreted as the type. This makes the proposed change backwards compatible with existing documentation.
* A minor cleanupJoon Ro2013-06-081-4/+2
| | | | - 4 indent instead of 2 for equation example - Fixed Syntax::
* DOC: fix a word in HOWTO_DOCUMENT.rst.txt.Warren Weckesser2013-05-301-1/+1
|
* DOC: Fix URL for "How to Build API/Reference Documentation"Dan Miller2013-05-241-1/+1
|
* DOC: use bold for section names, monospace for variables in HOWTO_DOCUMENT.endolith2012-12-041-13/+14
|
* Add note about definition list classifier formatendolith2012-11-301-8/+9
| | | and some other small changes
* DOC: Remove duplicate unique links in HOWTO_DOCUMENT.Stefan van der Walt2012-05-301-3/+3
|
* DOC: fix link and add explanation on how to run examples.Ralf Gommers2012-04-181-2/+16
|
* DOC: add note on formatting math to HOWTO_DOCUMENT.Ralf Gommers2011-09-271-0/+11
|
* STY: Fix spelling and reword text.Charles Harris2011-09-171-8/+8
|
* DOC: mention numpydoc in numpy conventionsValentin Haenel2011-09-171-0/+20
| | | | | Explain why it's good to use numpydoc and link to both numpydoc and some installation and usage instructions.
* DOC: Remove the advice to 'import scipy as sp' from the documentation.Robert Kern2011-04-011-4/+7
| | | | Correct a statement about how doctest namespaces are initialized in scipy.
* DOC: add deprecation section to docstandard. Closes #1501.Ralf Gommers2011-03-291-10/+32
|
* DOC: update class method docstring section of docstandard. Closes #1165.Ralf Gommers2011-03-291-1/+5
|
* DOC: update References section of docstandard. Closes #1509, #1524.Ralf Gommers2011-03-291-5/+2
|
* DOC: add description of how to document modules to the doc standard.Ralf Gommers2011-03-291-0/+25
| | | | Closes #1280.
* DOC: rename ReST files under doc/ from *.txt to *.rst.txt, so they render on ↵rgommers2010-11-111-0/+516
github.