All of lore.kernel.org
 help / color / mirror / Atom feed
* Requesting to change "doesn't" to "does not", isn't to "is not".
       [not found] <md5:4EcWvCzo9b/7898pSLmrOQ==>
@ 2017-08-18 11:50 ` Amit
  2017-08-18 12:12   ` Abhishek Lekshmanan
  2017-08-18 16:10   ` Adam C. Emerson
  0 siblings, 2 replies; 6+ messages in thread
From: Amit @ 2017-08-18 11:50 UTC (permalink / raw)
  To: ceph-devel@vger.kernel.org



Hello,

I believe coding guidelines does not speak about this.

But PR (https://github.com/ceph/ceph/pull/16705) talks on it. And its
still open.
If we donot agree on contractions, Let's close it.

Though "I am" instead of "I'm" -- both are completely correct English.
But I read on PR, It suits more on ESL speakers and takes care of
non-english speakers.

I believe while reviewing the PRs, we can ask developers for changing
"isn't" to "is not". [If we accept above PR?]
Would be a step in including "Strong Phrases, Active voices" into
documentation/Comments/std output..

What's your thought on it?

-- 
Thanks
Amit Kumar
!!If you stumble, get back up. 
What happened yesterday, no longer matters.
Today is another day to move closer to your GOAL!!



^ permalink raw reply	[flat|nested] 6+ messages in thread

* Requesting to change "doesn't" to "does not", isn't to "is not".
       [not found] <md5:lSMs+sMh6xWIc9sZLG92Qw==>
@ 2017-08-18 12:02 ` Amit
  0 siblings, 0 replies; 6+ messages in thread
From: Amit @ 2017-08-18 12:02 UTC (permalink / raw)
  To: ceph-devel@vger.kernel.org


Hello,

I believe coding guidelines does not speak about this.

But PR (https://github.com/ceph/ceph/pull/16705) talks on it. And its
still open.
If we donot agree on contractions, Let's close it.

Though "I am" instead of "I'm" -- both are completely correct English.
But I read on PR, It suits more on ESL speakers and takes care of
non-english speakers.

I believe while reviewing the PRs, we can ask developers for changing
"isn't" to "is not". [If we accept above PR?]
Would be a step in including "Strong Phrases, Active voices" into
documentation/Comments/std output..

What's your thought on it?

-- 
Thanks
Amit Kumar



^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Requesting to change "doesn't" to "does not", isn't to "is not".
  2017-08-18 11:50 ` Amit
@ 2017-08-18 12:12   ` Abhishek Lekshmanan
  2017-08-18 14:34     ` kefu chai
  2017-08-18 16:10   ` Adam C. Emerson
  1 sibling, 1 reply; 6+ messages in thread
From: Abhishek Lekshmanan @ 2017-08-18 12:12 UTC (permalink / raw)
  To: Amit, ceph-devel@vger.kernel.org

Amit <amitkuma@redhat.com> writes:

> Hello,
>
> I believe coding guidelines does not speak about this.
>
> But PR (https://github.com/ceph/ceph/pull/16705) talks on it. And its
ITYM it's here ;-)

> still open.
> If we donot agree on contractions, Let's close it.
>
> Though "I am" instead of "I'm" -- both are completely correct English.
> But I read on PR, It suits more on ESL speakers and takes care of
> non-english speakers.
>
> I believe while reviewing the PRs, we can ask developers for changing
> "isn't" to "is not". [If we accept above PR?]
> Would be a step in including "Strong Phrases, Active voices" into
> documentation/Comments/std output..

Well there are enough comments on the PR itself supporting/opposing it,
however in the PR itself, John Wilkins mentions that if approved, it
would be mostly automated scripts that'd doing the cleanups and not an
imposition on the community itself to do anything special, and this
would be better rather than requesting changes from PR submitters
themselves. My stance on contractions themselves resonate Nathan's
comments on the PR, but I'd not oppose whatever documentation team
decides as it.

However on code comments themselves I believe we shouldn't impose
anything, while typo fixes and obvious mistakes should be fixed, I think
it would be too much of an imposition if we expect every PR to confirm
to a contract of non contractions

Best,
Abhishek

SUSE Linux GmbH, GF: Felix Imendörffer, Jane Smithard, Graham Norton,
HRB 21284 (AG Nürnberg)

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Requesting to change "doesn't" to "does not", isn't to "is not".
  2017-08-18 12:12   ` Abhishek Lekshmanan
@ 2017-08-18 14:34     ` kefu chai
  0 siblings, 0 replies; 6+ messages in thread
From: kefu chai @ 2017-08-18 14:34 UTC (permalink / raw)
  To: Abhishek Lekshmanan; +Cc: Amit, ceph-devel@vger.kernel.org

On Fri, Aug 18, 2017 at 8:12 PM, Abhishek Lekshmanan <abhishek@suse.com> wrote:
> Amit <amitkuma@redhat.com> writes:
>
>> Hello,
>>
>> I believe coding guidelines does not speak about this.
>>
>> But PR (https://github.com/ceph/ceph/pull/16705) talks on it. And its
> ITYM it's here ;-)
>
>> still open.
>> If we donot agree on contractions, Let's close it.
>>
>> Though "I am" instead of "I'm" -- both are completely correct English.
>> But I read on PR, It suits more on ESL speakers and takes care of
>> non-english speakers.
>>
>> I believe while reviewing the PRs, we can ask developers for changing
>> "isn't" to "is not". [If we accept above PR?]
>> Would be a step in including "Strong Phrases, Active voices" into
>> documentation/Comments/std output..

no, i don't think we should enforce this. as this can be processed by
script. and it *is*. instead of struggling with the use of
contractions, IMHO, doc writers and reviewers need to focus on the
content.

>
> Well there are enough comments on the PR itself supporting/opposing it,
> however in the PR itself, John Wilkins mentions that if approved, it
> would be mostly automated scripts that'd doing the cleanups and not an
> imposition on the community itself to do anything special, and this
> would be better rather than requesting changes from PR submitters
> themselves. My stance on contractions themselves resonate Nathan's
> comments on the PR, but I'd not oppose whatever documentation team
> decides as it.
>
> However on code comments themselves I believe we shouldn't impose
> anything, while typo fixes and obvious mistakes should be fixed, I think
> it would be too much of an imposition if we expect every PR to confirm
> to a contract of non contractions

agreed. i think it does not make sense to be picky on the code
comments unless there are typos and syntax errors which fail to convey
the idea of the author and code.

>
> Best,
> Abhishek
>
> SUSE Linux GmbH, GF: Felix Imendörffer, Jane Smithard, Graham Norton,
> HRB 21284 (AG Nürnberg)
> --
> To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html



-- 
Regards
Kefu Chai

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Requesting to change "doesn't" to "does not", isn't to "is not".
  2017-08-18 11:50 ` Amit
  2017-08-18 12:12   ` Abhishek Lekshmanan
@ 2017-08-18 16:10   ` Adam C. Emerson
  2017-08-18 19:19     ` Nathan Cutler
  1 sibling, 1 reply; 6+ messages in thread
From: Adam C. Emerson @ 2017-08-18 16:10 UTC (permalink / raw)
  To: Amit; +Cc: ceph-devel@vger.kernel.org

On 18/08/2017, Amit wrote:
[snip]
> Though "I am" instead of "I'm" -- both are completely correct English.
> But I read on PR, It suits more on ESL speakers and takes care of
> non-english speakers.

Speaking as someone who was a lingusit in a past life, there is some
research on this. ‘I'm’, ‘can't’, ‘don't’, and other simple
contractions do not harm comprehension by second-language
learners. (The humongous amount of channel coding in natural language
is on their side here and the brain is well-adapted to using it.)

Contractions that elide syntactic elements have been shown to cause
some, slight difficulty in parsing by second language learners. For
example:

I'd gone if he'd said something.

for

I would have gone if he had said something.

The difficulty is usually quite minor.

While this sort of contraction isn't easy to transform with a script,
it also doesn't show up in software documentation. It occurs in speech
and written dialog and isn't really a concern for us.

There's also the infamous back formation often written by native but
uneducated English speakers:

You should of come with me.

for

You should have come with me.

This is basic illiteracy and we should rise in wrath against^W^W^W^Wgently
and kindly correct anyone who writes it.

> Would be a step in including "Strong Phrases, Active voices" into
> documentation/Comments/std output..

It is thought that the passive voice being banned must be firmly
condemned by all. No place should be found in our hearts or our style
guides for such restrictions. Mistakes were made by many well-meaning
authors by whom advice has been given, and the passive voice's being
thrown into disrepute is ranked high among them.

-- 
Senior Software Engineer           Red Hat Storage, Ann Arbor, MI, US
IRC: Aemerson@{RedHat, OFTC}
0x80F7544B90EDBFB9 E707 86BA 0C1B 62CC 152C  7C12 80F7 544B 90ED BFB9

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Requesting to change "doesn't" to "does not", isn't to "is not".
  2017-08-18 16:10   ` Adam C. Emerson
@ 2017-08-18 19:19     ` Nathan Cutler
  0 siblings, 0 replies; 6+ messages in thread
From: Nathan Cutler @ 2017-08-18 19:19 UTC (permalink / raw)
  To: Amit, ceph-devel@vger.kernel.org

>> Would be a step in including "Strong Phrases, Active voices" into
>> documentation/Comments/std output..

This is a standard recommendation for improving English writing style.

Like all elements of any language, passive voice is a well-established 
part of the English language and there are plenty of situations that 
warrant - or even demand - its use.

Therefore, such a recommendation should not be taken as a blanket law to 
be applied "roboticly" to all text ever written :-)

The intent of the recommendation is to call attention to a common 
stylistic failing - i.e. the *overuse* of passive voice.

Nathan

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2017-08-18 19:19 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
     [not found] <md5:lSMs+sMh6xWIc9sZLG92Qw==>
2017-08-18 12:02 ` Requesting to change "doesn't" to "does not", isn't to "is not" Amit
     [not found] <md5:4EcWvCzo9b/7898pSLmrOQ==>
2017-08-18 11:50 ` Amit
2017-08-18 12:12   ` Abhishek Lekshmanan
2017-08-18 14:34     ` kefu chai
2017-08-18 16:10   ` Adam C. Emerson
2017-08-18 19:19     ` Nathan Cutler

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.