PHPCSStandards / PHP_CodeSniffer

PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
BSD 3-Clause "New" or "Revised" License
856 stars 53 forks source link

Correct typos and language #457

Closed DannyvdSluijs closed 4 months ago

DannyvdSluijs commented 4 months ago

This PR addresses several typos and language constructs found throughout the sources. I've groups the fixes in individual commits in an attempt to make review easiest. Making individual PR for each type of typo feels weird and one for each file feels like an overhead.

Description

This PR address typos as found bij PHPStorm using the Problems view. Especially for the one where the introduction of a comma was suggested I've been withholding in addressing each issues as found by the editor. Especially for short sentences this would be not that helpfull.

Suggested changelog entry

Correct typos and language

Related issues/external references

N/A

Types of changes

PR checklist

DannyvdSluijs commented 4 months ago

I've noticed some test are failing which I'll address later tonight or at least this week.

jrfnl commented 4 months ago

@DannyvdSluijs Thanks for your willingness to contribute, but even just a quick glance at the changes, shows me quite a few are incorrect/introducing grammatical errors instead of fixing them.

Please do a very very very careful review of your proposed changes and update the branch to remove all the incorrect ones.

I'm tempted to close this PR as it is now, with an option to re-open it once you've had a chance to work out the kinks.

You may also want to consider splitting the PR in one which only touches docs files only, like the changelog and the readme and one which touches code files to make it more manageable.

DannyvdSluijs commented 4 months ago

Seeing the amount of files changes here in GH I can see this should be split.

but even just a quick glance at the changes, shows me quite a few are incorrect/introducing grammatical errors

I’m curious which ones as the detection was done by PHPStorm but every change was intentional and by hand. If you can share them that would be great.

I’ll close this for now and keep my branch as a reference and work on smaller PR’s addressing one type of issue at a time.

jrfnl commented 4 months ago

@DannyvdSluijs Thank you for understanding. I'll leave some comments inline to point out things I noticed when I first had a quick look.

jrfnl commented 4 months ago

@DannyvdSluijs I haven't gone through all of it, but just left some pointers now. Hope they help.