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: Punctuation on tutor #3888

Merged
merged 1 commit into from
Sep 23, 2022
Merged

docs: Punctuation on tutor #3888

merged 1 commit into from
Sep 23, 2022

Conversation

adrian5
Copy link
Contributor

@adrian5 adrian5 commented Sep 18, 2022

Correctness aside, “the line below marked” reads oddly, and makes one assume “below --->” for a second.

@the-mikedavis
Copy link
Member

I'm not sure this is more correct and the current text reads better to me. Can you explain?

My grammar is a bit rusty but the way I see it, the sentence breaks down like so

Move the cursor to the line below [which/that is] marked '-->'
|--|     |----| |---------------| |--------------------------|
Verb      Noun     Preposition      Defining Relative Clause

And I think it's a common blunder to use a comma to connect a defining relative clause - though it would be correct for a non-defining relative clause. (And it's defining because you need the information that the line is marked with the "-->" to know which line the sentence is referring to.)

@David-Else
Copy link
Contributor

David-Else commented Sep 18, 2022

@the-mikedavis Your grammar is good, there is no need for a defining relative clause or comma, I think it sounds correct as well as being correct.

@adrian5
Copy link
Contributor Author

adrian5 commented Sep 19, 2022

I think it sounds correct

Well, in speech one would make a pause after below, to differentiate:

Move the cursor to the line below [which is] marked '-->'
Move the cursor to the line below [the] marked items

I'm not a native speaker, but to me that reads better with a comma. Feel free to close if you disagree, I may be wrong.

@kirawi
Copy link
Member

kirawi commented Sep 20, 2022

Even though there may be a slight pause in speech, it is grammatically incorrect to have a comma.

@the-mikedavis
Copy link
Member

It might be clearer to use "Move the cursor to the line marked '-->' below". What do you think?

@adrian5
Copy link
Contributor Author

adrian5 commented Sep 21, 2022

That's clearer in my view. The marked '-->' is what's important (to look for), and below is only added to ensure the user goes looking in the right direction.

@kirawi kirawi added A-documentation Area: Documentation improvements S-waiting-on-review Status: Awaiting review from a maintainer. labels Sep 22, 2022
@the-mikedavis the-mikedavis merged commit 0d8d8a4 into helix-editor:master Sep 23, 2022
@the-mikedavis
Copy link
Member

Thanks!

herkhinah pushed a commit to herkhinah/helix that referenced this pull request Dec 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements S-waiting-on-review Status: Awaiting review from a maintainer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants