Skip to content
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

docs: assorted minor e.g. formatting improvements #2586

Merged

Conversation

sadielbartholomew
Copy link
Contributor

I've recently started development work using Tornado for the first time & naturally have been examining the documentation in detail to understand the internals.

I'm pedantic so along the way picked up on some (very) small issues e.g. in formatting (mainly missing capitalisation & plain text instances which would be more appropriate & readable as inline literals) which I noted down within an open branch.

I thought I might as well open this PR should you be happy to accept various such tweaks, or indeed a subset of them as I am happy to remove any changes that are unwanted. However if this seems excessive I am happy to close the PR.

@ploxiln
Copy link
Contributor

ploxiln commented Feb 9, 2019

I'm not sure how the whole thing will be received, but there's at least few good fixes in there. To get tests passing I think you'll just have to deal with:

.../tornado/docs/guide/coroutines.rst:66: WARNING: Unexpected indentation.
.../tornado/docs/guide/coroutines.rst:67: WARNING: Block quote ends without a blank line; unexpected unindent.
.../tornado/docs/guide/coroutines.rst:74: WARNING: Unexpected indentation.
.../tornado/docs/guide/coroutines.rst:77: WARNING: Block quote ends without a blank line; unexpected unindent.

@sadielbartholomew
Copy link
Contributor Author

@ploxiln sure, thank you for your rapid response.

I've put suggestions in as a batch for convenience but can revert any as requested. I develop with Python 3.6 so didn't see any Sphinx-based failures locally but will address these Travis failures & squash in a commit to fix them.

@bdarnell
Copy link
Member

bdarnell commented Feb 9, 2019

Thanks, this looks great!

@bdarnell bdarnell merged commit 89993db into tornadoweb:master Feb 9, 2019
@sadielbartholomew sadielbartholomew deleted the minor-docs-improvements branch February 12, 2019 17:08
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