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: Update `scheduling.rst` [skip ci] #4265

Merged
merged 3 commits into from Dec 10, 2018

Conversation

Projects
None yet
2 participants
@farrajota
Copy link
Member

commented Dec 3, 2018

This PR updates scheduling.rst with some punctuation, naming conventions and typo corrections (a couple). Also, a few connecting words were sprinkled here and there to improve clarity of some sentences.

Docs: Update `scheduling.rst` [skip ci]
This PR updates `scheduling.rst` with some punctuation, naming conventions and typo corrections (a couple). Also, a few connecting words were sprinkled here and there to improve clarity of some sentences.
Show resolved Hide resolved docs/source/scheduling.rst Outdated
Show resolved Hide resolved docs/source/scheduling.rst Outdated
more features, but also requires a bit more effort to set up. It can
run locally or distributed across a cluster.

This comment has been minimized.

Copy link
@mrocklin

mrocklin Dec 4, 2018

Member

I think that we should keep the period here. This is a complete sentence and is not in a place where we care about minimizing visual space (like a title page)

This comment has been minimized.

Copy link
@farrajota

farrajota Dec 4, 2018

Author Member

I see your point. For short descriptions it's fine not ending with a dot, and it makes sense using periods for full sentences, but what would be the case where it is hard to distinguish between these two (i.e., when its a long description but not quite a sentence)? So far I've been using the simple rule of not using periods in lists (like in #4020)

Would the rule of thumb be no ending dots for all short descriptions and dots for more than one sentence per item in a list? or avoid using ending dots completely in lists?

What are your thoughts about this?

This comment has been minimized.

Copy link
@mrocklin

mrocklin Dec 5, 2018

Member

but what would be the case where it is hard to distinguish between these two

No strong thoughts. Defaulting to no-dots seems fine if you prefer.

This comment has been minimized.

Copy link
@farrajota

farrajota Dec 5, 2018

Author Member

Lets not use dots as default for now and latter change it if it seems more appropriate

farrajota and others added some commits Dec 4, 2018

Fix typo [skip ci]
Co-Authored-By: farrajota <farrajota@users.noreply.github.com>

@mrocklin mrocklin merged commit 1bd06e5 into dask:master Dec 10, 2018

@mrocklin

This comment has been minimized.

Copy link
Member

commented Dec 10, 2018

Merged. Thanks as always @farrajota

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.