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

“Can be set, to” #7160

Closed
j9t opened this issue Oct 5, 2021 · 3 comments
Closed

“Can be set, to” #7160

j9t opened this issue Oct 5, 2021 · 3 comments

Comments

@j9t
Copy link
Contributor

j9t commented Oct 5, 2021

In 89 cases, the specification starts a sentence with “Can be set, to”, like in “Can be set, to change the URL.”. To me the comma looks superfluous, and that removing it improves reading flow.

As there are so many occurrences I’m filing this issue. I’m happy to prepare a PR once there’s a signal this can be changed.

@Kaiido
Copy link
Member

Kaiido commented Oct 5, 2021

I'm not that proficient in English so I won't comment the gramatical correctness of the thing, but at least I see that the pattern is

  • Can be set to a value
  • Can be set, to do something

And as a developper that makes a lot of sense to me: some properties can not be set, letting us know that here it can be set, and that it will do X is expected.

@j9t
Copy link
Contributor Author

j9t commented Oct 6, 2021

That a comma is (or can be) fine is not the point, but that the sentences in question seem to work without it. That is, the suggestion aims at avoiding to unnecessarily slow reading flow.

@domenic
Copy link
Member

domenic commented Oct 7, 2021

I don't think it makes the reading flow "unnecessarily slow"; it makes it have just the intended pace.

In general it's best to assume that when something is a subjective preference, we'd prefer to keep the existing style.

@domenic domenic closed this as completed Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants