Skip to content

[3.4] Fixed many spelling issues found in the docs #12610

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

Merged
merged 1 commit into from
Nov 10, 2019

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Nov 8, 2019

I was planning to do this for a long time: Run the Sphinx spelling checker on the Symfony documentation.

This PR fixes quite a lot of spelling issues found in the files starting with b and c for the 3.4 branch. I think it's good to have these fixed, so I'm happy to merge this myself and fix any merge conflicts that might occur while doing the up-merge once.

Meanwhile, I'm also preparing a "word list" of words that the spelling checker doesn't recognize. The spelling checker uses Enhant, which is also available for PHP. So we might be able to add this to DOCtor when all issues are fixed.

cc @symfony/team-symfony-docs

Copy link
Contributor

@OskarStark OskarStark left a comment

Choose a reason for hiding this comment

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

Amazing work Wouter 🥰

Retrieving the Message Catalog
------------------------------

In case you want to use the same translation catalog outside your application
Copy link
Contributor

Choose a reason for hiding this comment

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

outside of ?

Copy link
Member Author

@wouterj wouterj Nov 8, 2019

Choose a reason for hiding this comment

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

https://english.stackexchange.com/questions/9700/outside-or-outside-of

So this is a real hard one (at least for non-natives). Seems like "outside of" is more American English, but it also has the meaning "except for" and not "outside". So I would say "outside" (without "of") is the right word here.

wouterj added a commit that referenced this pull request Nov 10, 2019
…erj)

This PR was merged into the 3.4 branch.

Discussion
----------

[3.4] Fixed many spelling issues found in the docs

I was planning to do this for a long time: Run the [Sphinx spelling checker](https://pypi.org/project/sphinxcontrib.spelling/) on the Symfony documentation.

This PR fixes quite a lot of spelling issues found in the files starting with `b` and `c` for the 3.4 branch. I think it's good to have these fixed, so I'm happy to merge this myself and fix any merge conflicts that might occur while doing the up-merge once.

Meanwhile, I'm also preparing a "word list" of words that the spelling checker doesn't recognize. The spelling checker uses Enhant, which is [also available for PHP](https://www.php.net/manual/en/book.enchant.php). So we might be able to add this to DOCtor when all issues are fixed.

cc @symfony/team-symfony-docs

Commits
-------

bb5fb7b Fixed many spelling issues
@wouterj wouterj merged commit bb5fb7b into symfony:3.4 Nov 10, 2019
@wouterj wouterj deleted the spelling-3.4-1 branch November 10, 2019 12:42
@xabbuh xabbuh mentioned this pull request Nov 12, 2019
OskarStark added a commit that referenced this pull request Nov 12, 2019
This PR was merged into the 3.4 branch.

Discussion
----------

fix some more typos

continues #12610

Commits
-------

d112688 fix some more typos
wouterj added a commit that referenced this pull request Jan 4, 2020
…wouterj)

This PR was squashed before being merged into the 3.4 branch (closes #12837).

Discussion
----------

[3.4] Fixed everything found by the spellcheck builder

This completes what I started in #12610

I've also committed the custom word list and Sphinx configuration. This way, everyone is able to run it (and I accidentially removed the word list after the last time, so I don't want to loose it again).

Some quick notes:

* Many titles that consisted of option or function names are transformed to be a literal. This is supported by Sphinx and all references still work. On symfony.com code elements in a title are ignored and titles are displayed as normal (see https://symfony.com/doc/current/components/filesystem for an example)
* I once again updated many cases of library names. I used the main website/documentation of each library to find the proper casing (e.g. NGINX, webpack, npm and HInclude.js).

*To avoid merge conflicts, I will merge this PR asap. Don't worry about the merge conflicts: I'll resolve them once and then they should no longer occur*

Commits
-------

715a4e7 [3.4] Fixed everything found by the spellcheck builder
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