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

Update some terminology based on AlexJS reports #14215

Merged
merged 1 commit into from
Sep 13, 2020
Merged

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Sep 10, 2020

This PR replaces some insensitive/inconsiderate terminology based on AlexJS reports. It's very much subjective, I've not fixed all things AlexJS provided and even AlexJS (while based on official sources) implements some sort of subjective list of words to be considered insensitive/inconsiderate.

99% of the changes in this PR are:

  • Removing "just", "basically", "simple", "easy" as much as possible (most of the time, removing the word was enough);
  • Replacing "execute" with "run" (commands) or "call" (methods/controllers/etc)

Because sometimes AlexJS reports words that are fine in that context (and AlexJS has some trouble understanding rst syntax), I don't think we can run AlexJS as part of our GitHub actions. I did however commit the .alexjsrc file to ease local use. For instance, I'm using Vim with ALE. This asynchronously runs everything I type in *.rst or *.md files through Alex; commiting the Alex config makes it easier for me to spot mistakes.

cc @lsmith77 @javiereguiluz

Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

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

Thanks for this! Nice changes!

introduction/from_flat_php_to_symfony.rst Show resolved Hide resolved
@javiereguiluz
Copy link
Member

@wouterj as you know this kind of PR are "problematic" because they change lots of files, so they introduce lots of conflicts quickly. So, do you think it's ready for merge or do you want to make more changes? If it's ready, do you want to merge this yourself or do you want me to do it? Thanks!

bundles.rst Show resolved Hide resolved
@lsmith77
Copy link
Contributor

great work .. I am hoping that one day (sooner rather than later) I can provide a scanner that is better at dealing with context that we can integrate but until then I think it is a great idea to just run such analysis on a regular basis with manual review.

@wouterj wouterj merged commit 7b96090 into symfony:4.4 Sep 13, 2020
@wouterj wouterj deleted the alex/4.4 branch September 13, 2020 10:54
wouterj added a commit that referenced this pull request Sep 13, 2020
* 4.4:
  [#14215] Replace dummy with a better alternative
wouterj added a commit that referenced this pull request Sep 13, 2020
* 5.1:
  [#14215] Replace dummy with a better alternative
@lsmith77
Copy link
Contributor

lsmith77 commented Sep 13, 2020 via email

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

Successfully merging this pull request may close these issues.

4 participants