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

Add second person rule #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

ChrisChinchilla
Copy link
Collaborator

No description provided.

Copy link
Member

@jdkato jdkato left a comment

Choose a reason for hiding this comment

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

Shouldn't this use the existence extension point?

Use second person ("you") when speaking to or about the reader. Authors can refer to themselves in the first person ("I" in single-author articles or "we" in multiple-author articles) but should keep the focus on the reader.

This seems to imply that we should ensure instances of "I" or "we" are only in reference to the author(s) rather than checking that "you" and "we" aren't used together.

@gaurav-nelson
Copy link
Collaborator

gaurav-nelson commented Apr 16, 2020

I agree, we should use existence to check the usage of "I" and "we".

@ChrisChinchilla
Copy link
Collaborator Author

Hmm, my reasoning was for more of a check on consistency, so the predominance of using "I" in a doc, instead of "we". If we just check for existence, then it's not so useful without context, which is not something Vale can do.

Unless I am misunderstanding what you both mean, I kind of see how both could do the same, but the consistency part was my reasoning.

@jdkato
Copy link
Member

jdkato commented Apr 22, 2020

I think I understand your intent better now. The part of the description that says

"I" in single-author articles or "we" in multiple-author articles

could indeed be a candidate for consistency since an article can't be both single- and multi-author. (As written, though, the rule involves "we" and "you"; not "we" and "I" ...?)

If we just check for existence, then it's not so useful without context, which is not something Vale can do.

IMO, this is an ideal case for a sub-error level rule (which can be selectively disabled): It alerts writers to the fact that, according to the style guide, that they're only supposed to use "I" and "we" in certain contexts without explicitly telling them that they're doing something "wrong" (which they might not be). The alternative (limiting ourselves to precise, error-candidate rules), means we'll end up covering much less of the style guide.


Basically, from my understanding of the discussion so far, we're looking at the two following rules:

extends: consistency
message: 'Use "I" in single-author articles or "we" in multiple-author articles.'
level: error
link: https://www.ibm.com/developerworks/library/styleguidelines/#N10050
either:
  I: we 

and

extends: existence
message: 'Only use "%s" when referring to yourself, the author(s).'
level: warning
link: https://www.ibm.com/developerworks/library/styleguidelines/#N10050
tokens:
    - I
    - we

Does this seem right?

@ChrisChinchilla
Copy link
Collaborator Author

Huh, interesting, I think I need to try implementing to see if it matches, but makes sense.

Is "sub-error level rule" an actual thing @jdkato or did you just use that as a description?

@jdkato
Copy link
Member

jdkato commented May 1, 2020

By "sub-error" I meant warning or suggestion, which don't result in non-zero return codes.

@ChrisChinchilla
Copy link
Collaborator Author

By "sub-error" I meant warning or suggestion, which don't result in non-zero return codes.

Ah ha, OK, yes, I tend to err on that side of caution for "warnings" anyway.

@ChrisChinchilla
Copy link
Collaborator Author

OK, reminded to get back to this PR

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