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

Improve wording in README #915

Merged
merged 1 commit into from
Oct 21, 2023
Merged

Conversation

szepeviktor
Copy link
Contributor

@szepeviktor szepeviktor commented Sep 20, 2023

@kubawerlos This is all my English knowledge.

Copy link
Owner

@kubawerlos kubawerlos left a comment

Choose a reason for hiding this comment

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

Hi @szepeviktor,

thanks for the improvements and sorry for the late response (I was on GitHub detox 😁).

Generally changes to docs must be made via the code (fixer's descriptions and ReadmeCommand and then running php .dev-tools/generate_readme.php > README.md, or simply composer fix), but the pipeline is failing anyway (due to changes in the Fixer's repo), so I will merge this one and make a follow up with changes in code to match README.

However, that will revert the descriptions of DataProvider* as they took the description from the Fixer repo: https://github.com/kubawerlos/php-cs-fixer-custom-fixers/blob/v3.16.2/src/Fixer/DataProviderNameFixer.php#L46

Would you like to create a PR there (similar flow - changing description in code and running ./dev-tools/doc is needed) or do you want me to do it?

@@ -318,7 +318,7 @@ Configuration options:
```

#### NoTrailingCommaInSinglelineFixer
Trailing comma in the list on the same line as the end of the block must be removed.
There must be no trailing comma in arrays written on one line.
Copy link
Owner

Choose a reason for hiding this comment

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

This fixer changes foo(1, 2, ); and list($x, $y) = $list; too.

@kubawerlos kubawerlos merged commit aabbf27 into kubawerlos:main Oct 21, 2023
3 of 12 checks passed
@szepeviktor szepeviktor deleted the patch-1 branch October 21, 2023 09:12
@szepeviktor
Copy link
Contributor Author

Would you like to create a PR there (similar flow - changing description in code and running ./dev-tools/doc is needed) or do you want me to do it?

I would like you to create that PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants