Skip to content

Conversation

@fedsten
Copy link

@fedsten fedsten commented Aug 28, 2018

It is considered a best practice to avoid noun+verb contractions in technical documentation as it makes it easier to read, especially for non native English speakers.
As a reference: https://developers.google.com/style/contractions

@laanwj laanwj added the Docs label Aug 28, 2018
@practicalswift
Copy link
Contributor

@fedsten Is this change exhaustive throughout the documentation? git grep might help you find similar cases :-)

@DrahtBot
Copy link
Contributor

DrahtBot commented Aug 29, 2018

Note to reviewers: This pull request conflicts with the following ones:

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

@ken2812221
Copy link
Contributor

Please squash these changes into single commit.

@laanwj laanwj changed the title Minor style enhacement in documentation Minor style enhancement in documentation Aug 31, 2018
@fedsten
Copy link
Author

fedsten commented Aug 31, 2018

I updated the pull request and made sure the change is exhaustive throughout the documentation

@fanquake
Copy link
Member

fanquake commented Sep 2, 2018

I've looked through all the changes here, and they are basically just changing:
there's -> there is
they'll -> they will
they've -> they have
you're -> you are
you've -> you have
we'll -> we will
we're -> we are

across the entire repository. Given this isn't actually fixing anything, it has a large number of conflicts and it fails the linter because it's modifying subtrees, I'm just going to close this sorry.

edit: This type of change is normally best suited right at the end of a merge window, when conflicts and other issues aren't a problem.

@fanquake fanquake closed this Sep 2, 2018
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants