Skip to content

[3.4] Fixed everything found by the spellcheck builder #12837

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
Jan 4, 2020

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Dec 23, 2019

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

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.

Wouter, thanks a lot for this huge effort!

@wouterj wouterj force-pushed the spelling/3.4-3 branch 3 times, most recently from 37acbb8 to 3ee6d8a Compare December 24, 2019 15:56
@wouterj
Copy link
Member Author

wouterj commented Dec 24, 2019

@javiereguiluz this PR introduces some usage of the .. spelling:: directive that is provided by the sphinxcontrib-spelling package python package. Using it should be as simple as installing this package using pip. Are we able to install this package on the symfony.com server? (requires apt install enchant and pip install sphinxcontrib-spelling==4.2.0 pyenchant, we have to have v4.2.0 of the spelling package).

An alternative solution would be to remove this directives and add the remaining spellings to the wordlist and comment out the spelling configuration. But I'm not a huge fan of that (i.e. plaintext is correct in Security concept, but wrong in e.g. Console documentation).

@javiereguiluz
Copy link
Member

@wouterj about the .. spelling directive ... I don't know what to say yet. I'm not sure if we could install this package ... and I don't know if this could impact @weaverryan's new build tool.

@wouterj
Copy link
Member Author

wouterj commented Jan 2, 2020

For the new build tool, it would be a matter of creating the PHP class for this directive. Nothing needs to be rendered, so we just need to have the class to not have the tool fail on not knowing the directive.

However, the easiest is to just add them to the global word list. I'll make that change shortly :)

@wouterj wouterj force-pushed the spelling/3.4-3 branch 3 times, most recently from 5757d6b to 4f21744 Compare January 4, 2020 12:36
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
@wouterj wouterj merged commit 715a4e7 into symfony:3.4 Jan 4, 2020
@wouterj wouterj deleted the spelling/3.4-3 branch January 4, 2020 13:35
@xabbuh xabbuh mentioned this pull request Jan 4, 2020
javiereguiluz added a commit that referenced this pull request Jan 7, 2020
This PR was merged into the 3.4 branch.

Discussion
----------

some spelling updates

continues #12837

Commits
-------

ba7f2fd some spelling updates
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