Skip to content

Doc lint fixes.#731

Merged
jmchilton merged 1 commit intogalaxyproject:masterfrom
jmchilton:doc_lint
Sep 15, 2017
Merged

Doc lint fixes.#731
jmchilton merged 1 commit intogalaxyproject:masterfrom
jmchilton:doc_lint

Conversation

@jmchilton
Copy link
Member

No description provided.

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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's https://conda.io/ nowadays.


@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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't that be indented?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in the line above?

True of False --> True or False

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants