Correct typos and language #457

DannyvdSluijs · 2024-04-22T15:52:19Z

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

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
- This change is only breaking for integrators, not for external standards or end-users.
Documentation improvement

PR checklist

I have checked there is no other PR open for the same change.
I have read the Contribution Guidelines.
I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
I have added tests to cover my changes.
I have verified that the code complies with the projects coding standards.
[Required for new sniffs] I have added XML documentation for the sniff.

DannyvdSluijs · 2024-04-22T15:53:41Z

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

jrfnl · 2024-04-22T16:20:14Z

@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 · 2024-04-23T06:42:06Z

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 · 2024-04-23T08:54:31Z

@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 · 2024-04-23T08:55:37Z

.github/CONTRIBUTING.md

-Parse/compile errors can take various forms. Some can be handled without much problems by PHPCS, some can not.
+Parse/compile errors can take various forms. Some can be handled without many problems by PHPCS, some can not.


"without much problems" is an expression and is correct. "without many problems" changes the meaning of the sentence.

jrfnl · 2024-04-23T08:56:30Z

reproductions/3875.php

@@ -0,0 +1,3 @@
+<?php


This file doesn't belong here.

jrfnl · 2024-04-23T08:57:12Z

src/Config.php

@@ -61,7 +61,7 @@
 * @property bool       $stdin           Read content from STDIN instead of supplied files.
 * @property string     $stdinContent    Content passed directly to PHPCS on STDIN.
 * @property string     $stdinPath       The path to use for content passed on STDIN.
- * @property bool       $trackTime       Whether or not to track sniff run time.


There is nothing wrong with the original text as far as I can see. (here and below)

jrfnl · 2024-04-23T08:59:52Z

src/Standards/MySource/Sniffs/Channels/IncludeSystemSniff.php

-                // Special case for Widgets cause they are, well, special.
+                // Special case for Widgets because they are, well, special.


I'd accept this change, but cause is valid English, though maybe colloquial.

jrfnl · 2024-04-23T09:00:46Z

src/Standards/PEAR/Sniffs/WhiteSpace/ScopeClosingBraceSniff.php

-        // then the opener is sharing its closer with other tokens. We only
+        // then the opener is sharing it's closer with other tokens. We only


its is correct.

jrfnl · 2024-04-23T09:01:44Z

src/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.1.inc

@@ -17,7 +17,7 @@ declare(encoding='utf-8');
 * that is available through the world-wide-web at the following URI:
 * http://www.php.net/license/3_0.txt.  If you did not receive a copy of
 * the PHP License and are unable to obtain it through the web, please
-* send a note to [email protected] so we can mail you a copy immediately.
+* send a note to [email protected], so we can mail you a copy immediately.


This is a predefined text in the tests and should not be changed.

jrfnl · 2024-04-23T09:04:54Z

src/Tokenizers/Tokenizer.php

-                        // We found the a token that looks like the opener, but it's nested differently.
+                        // We found the token that looks like the opener, but it's nested differently.


The "the" should be removed, the "a" is correct.

jrfnl · 2024-04-23T09:05:17Z

src/Tokenizers/Tokenizer.php

-                        // This opener shares its closer with the previous opener,
+                        // This opener shares it's closer with the previous opener,


its is correct.

jrfnl · 2024-04-23T09:06:12Z

src/Util/Standards.php

-            // If it has an XML extension, let's at least try it.
+            // If it has an XML extension, lets at least try it.


I believe the let's is correct here, but wouldn't mind a second opinion.

"let's" is short for "let us", which is correct in this context. "lets" is a conjugation of "to let" - eg, "I let", "you let", "she lets".

jrfnl · 2024-04-23T09:06:49Z

tests/ConfigDouble.php

- * with the exception of select tests for the Config class itself.
+ * except select tests for the Config class itself.


Nothing wrong with the original phrasing.

jrfnl · 2024-04-23T09:07:41Z

tests/Core/File/GetMethodParametersTest.php

-     * Verify recognition of PHP8 constructor with both property promotion as well as normal parameters.
+     * Verify recognition of PHP8 constructor with both property promotion and normal parameters.


This changes the meaning (though subtly).

jrfnl · 2024-04-23T09:08:36Z

tests/Core/File/GetTokensAsStringTest.php

-     * @param int|string $startTokenType The type of token(s) to look for for the start of the string.
+     * @param int|string $startTokenType The type of token(s) to look for the start of the string.


This change is incorrect. The original may look strange with the double for, but is correct. (same below)

jrfnl · 2024-04-23T09:09:45Z

tests/Core/Tokenizer/TypedConstantsTest.php

-     * Test the tokens in the type of a typed constant as well as the constant name are tokenized correctly.
+     * Test the tokens in the type of typed constant as well as the constant name are tokenized correctly.


This change makes the sentence grammatically incorrect.

jrfnl · 2024-04-23T09:10:44Z

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

DannyvdSluijs added 5 commits April 19, 2024 22:06

docs: Correcting missing and redundant dashes

d1eb42f

docs: Add comma's where needed to pause long sentences

d68c335

docs: Correct missing or redundant single quote

01c7273

docs: Correct abbreviations with missing dots

a907380

docs: Correct language

c11f18f

jrfnl removed Core Component: Ruleset Core Component: File Core Component: Reports Core Component: Tokenizer Core Component: Utils Focus: Comments/Docblocks Standard: Generic Standard: MySource labels Apr 22, 2024

jrfnl added Status: awaiting feedback and removed Standard: PEAR Standard: PSR2 Standard: PSR12 Standard: Squiz Standard: Zend labels Apr 22, 2024

DannyvdSluijs closed this Apr 23, 2024

github-actions bot removed Status: triage Status: awaiting feedback labels Apr 23, 2024

jrfnl reviewed Apr 23, 2024

View reviewed changes

reproductions/3875.php

@@ -0,0 +1,3 @@

<?php

Copy link

Member

jrfnl Apr 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file doesn't belong here.

jrfnl reviewed Apr 23, 2024

View reviewed changes

This was referenced Apr 24, 2024

docs: Correct semi-colon for semicolon (without dash) #464

Merged

docs: Correct semi-colon for semicolon (without dash) php-fig/fig-standards#1322

Merged

		Parse/compile errors can take various forms. Some can be handled without much problems by PHPCS, some can not.
		Parse/compile errors can take various forms. Some can be handled without many problems by PHPCS, some can not.

		// Special case for Widgets cause they are, well, special.
		// Special case for Widgets because they are, well, special.

		// then the opener is sharing its closer with other tokens. We only
		// then the opener is sharing it's closer with other tokens. We only

		// We found the a token that looks like the opener, but it's nested differently.
		// We found the token that looks like the opener, but it's nested differently.

		// This opener shares its closer with the previous opener,
		// This opener shares it's closer with the previous opener,

		// If it has an XML extension, let's at least try it.
		// If it has an XML extension, lets at least try it.

		* with the exception of select tests for the Config class itself.
		* except select tests for the Config class itself.

		* Verify recognition of PHP8 constructor with both property promotion as well as normal parameters.
		* Verify recognition of PHP8 constructor with both property promotion and normal parameters.

		* @param int\|string $startTokenType The type of token(s) to look for for the start of the string.
		* @param int\|string $startTokenType The type of token(s) to look for the start of the string.

		* Test the tokens in the type of a typed constant as well as the constant name are tokenized correctly.
		* Test the tokens in the type of typed constant as well as the constant name are tokenized correctly.

Uh oh!

Correct typos and language #457

Correct typos and language #457

Uh oh!

Conversation

DannyvdSluijs commented Apr 22, 2024

Description

Suggested changelog entry

Related issues/external references

Types of changes

PR checklist

Uh oh!

DannyvdSluijs commented Apr 22, 2024

Uh oh!

jrfnl commented Apr 22, 2024

Uh oh!

DannyvdSluijs commented Apr 23, 2024

Uh oh!

jrfnl commented Apr 23, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jrfnl Apr 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jrfnl commented Apr 23, 2024

Uh oh!

Uh oh!

jrfnl Apr 23, 2024 •

edited

Loading