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

chore(docs): Update schema doc to second person reference #18990

Closed

Conversation

sagarnasit
Copy link
Contributor

issue: #18284

@sagarnasit sagarnasit requested a review from a team as a code owner October 24, 2019 21:34
@sagarnasit sagarnasit changed the title chore(docs): Update schema doc to third person reference chore(docs): Update schema doc to second person reference Oct 24, 2019
@LekoArts
Copy link
Contributor

Hi, thanks for the PR!
However, in this current state we can't merge it as your changes are wrong referring to this paragraph in our docs:

When updating a doc to adhere to this part of the Gatsby Style Guide, one exception in English is when “we” refers to Gatsby’s core processes. The subject is the code in this case, rather than a teacher/reader connotation, and should be rewritten or restructured to not confuse the reader about what they are responsible for doing when something is happening automatically behind the scenes.

Please change your PR accordingly as switching we with you is not appropriate here. Thanks!

@LekoArts LekoArts added status: awaiting author response Additional information has been requested from the author type: documentation An issue or pull request for improving or updating Gatsby's documentation labels Oct 28, 2019
@sagarnasit
Copy link
Contributor Author

@LekoArts Updated the doc.

@marcysutton
Copy link
Contributor

Hi there, the changed file still has the word "we" in it. Can you update it to follow the style guide to use Gatsby as the subject?

@sagarnasit
Copy link
Contributor Author

Done.

@LekoArts
Copy link
Contributor

Hi, I'm closing this PR since the current state of this PR is not addressing our comments. Changing we to you isn't enough in this context.
Feel free to open a new PR when you've made those changes. Thanks!

@LekoArts LekoArts closed this Nov 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: awaiting author response Additional information has been requested from the author type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants