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

Put all Taglines & most Option descriptions in active, present tense #3018

Closed
wants to merge 1 commit into from

Conversation

JesseWeinstein
Copy link
Contributor

For consistency. This should probably be documented somewhere, too.

@atomgardner
Copy link
Contributor

Hi, I think the imperative mood is the default for this subset of
technical writing. Some non-IPFS examples include,

`git`, `go`, `gcc --help`.

@JesseWeinstein
Copy link
Contributor Author

Sigh. I was afraid that might be the case. Well, if we settle on imperative, I'll make them all consistent with THAT, instead.

@RichardLitt
Copy link
Member

This should be documented here: https://github.com/ipfs/community/blob/master/docs-styleguide.md. Might be good to open an issue about it in ipfs/community before doing all of the changes again, in case we want to weigh in on it not only for go-ipfs but also for other repos.

@whyrusleeping whyrusleeping added the status/blocked Unable to be worked further until needs are met label Aug 4, 2016
@whyrusleeping
Copy link
Member

blocked on resolution of ipfs/community#150

@jbenet
Copy link
Member

jbenet commented Aug 4, 2016

Please keep using imperative. It's a decades old convention for unix
tooling.

And I think it's much better, too. Think of it like a button. Buttons in an
airplane don't say "[this button] turns the engine on". They say "Turn the
engine on". These descriptions are putting in writing what "the user will
do" by executing that command (pushing the button) instead of doing it
manually.
On Thu, Aug 4, 2016 at 09:54 Jeromy Johnson [email protected]
wrote:

blocked on resolution of ipfs/community#150
ipfs/community#150


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#3018 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAIcoczVGQ5LATN2x2vcT8GMFCmIdK1eks5qce8hgaJpZM4JY92h
.

@JesseWeinstein
Copy link
Contributor Author

OK, I've closed this PR, and will make another (much smaller) one to fix the few taglines & options descriptions that weren't in imperative mood.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/blocked Unable to be worked further until needs are met
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants