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

Doc lint fixes. #731

Merged
merged 1 commit into from Sep 15, 2017

Conversation

Projects
None yet
3 participants
@jmchilton
Copy link
Member

jmchilton commented Sep 15, 2017

No description provided.

@jmchilton jmchilton merged commit 8518b78 into galaxyproject:master Sep 15, 2017

1 check was pending

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
@@ -257,6 +257,7 @@ environments such as Amazon Web Services and Google Compute Engine.

.. _Galaxy: http://galaxyproject.org/
.. _Docker: https://www.docker.com/
.. _Conda: http://conda.pydata.org/

This comment has been minimized.

@nsoranzo
@param timeout: in seconds, if None or 0 wait forever
@return: True of False, if ``timeout`` is ``None`` may return only True or
throw unhandled network exception

This comment has been minimized.

@nsoranzo

nsoranzo Sep 15, 2017

Member

Shouldn't that be indented?

This comment has been minimized.

@jmchilton

jmchilton Sep 15, 2017

Author Member

I tried the old way, I tried two spaces, 4 spaces, Sphinx hates everything but this.

This comment has been minimized.

@peterjc

peterjc Sep 15, 2017

Contributor

Typo in the line above?

True of False --> True or False

This comment has been minimized.

@nsoranzo

nsoranzo Sep 15, 2017

Member

Shouldn't these start with a : http://www.sphinx-doc.org/en/stable/domains.html#info-field-lists

:param timeout: ...
:return: ...

This comment has been minimized.

@jmchilton

jmchilton Sep 15, 2017

Author Member

Revised the docs to implement this I think.

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