Docstring formatting issue

[cdeil]

Have a look at http://ccdproc.readthedocs.org/en/latest/api/ccdproc.ccd_process.html ... there's some formatting issues with the docstring:

For the bullets you have to add an empty line above.
For the parameter types, you have to add a space before the colon to make them appear correctly.

@bsipocz - Is there a way to catch such issues in the Sphinx build and on travis-ci?
Probably we also have 100s of those in Gammapy and other affiliated packages?
Would be really nice if catching such things could be automated.

[bsipocz]

@cdeil - even if there's a way I don't know what it is rather than the reviewer spots them in time.
Syntactically both ways are right and sphinx just happens to render one of them.

[crawfordsm]

NIce spot @cdeil

Maybe a utility to add to astropy helpers to run to look for things like this?

[bsipocz]

@crawfordsm - I'm 👎 on this as I don't think that astropy_helpers is a place for convenience scripts like this.
A more appropriate place for it would be https://github.com/astropy/astropy-tools.

[cdeil]

I've split the feature request for a tool that automatically checks docstring formatting to
astropy/astropy-tools#11

[MSeifert04]

I haven't seen this issue but I think in #341 this will be fixed. Is there a way post-first-commit to link this issue as Fixes ... to the PR?

[bsipocz]

@MSeifert04 - You can do it in the commit message of any of the commits. [0] Alternatively you can always edit the text of the PR, and do it there. [1]

[0] - https://help.github.com/articles/closing-issues-via-commit-messages/
[1] - https://github.com/blog/1506-closing-issues-via-pull-requests

[MSeifert04]

@bsipocz Thank you. It worked.