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

fix(docs): Fix lint errors and add more nouns to the dictionary #25270

Merged
merged 1 commit into from
Jun 24, 2020

Conversation

tesseralis
Copy link
Contributor

Description

Fix linting errors on new docs.

@tesseralis tesseralis requested review from a team as code owners June 24, 2020 22:09
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jun 24, 2020
@marcysutton
Copy link
Contributor

marcysutton commented Jun 24, 2020

Thanks for the prompt PR! Fixing linting errors is excellent. Related to #25268, is adding every proper noun to the dictionary the most sustainable way forward? That seems like we'll be chasing these warnings forever, especially for community contributions.

@tesseralis tesseralis merged commit 0d23e7e into master Jun 24, 2020
@delete-merged-branch delete-merged-branch bot deleted the fix-dictionary branch June 24, 2020 23:34
@tesseralis
Copy link
Contributor Author

@marcysutton I'd argue it's not necessarily a bad idea. Proper nouns (people names, brand names) have proper spellings/capitalization as well and should be checked. In the initial PR, I ended up fixing a fair amount of inconsistencies in how library/brand names are spelled, so I think it's a good idea to add them. The other main category of "new words" are code, and those should be put in backticks anyway to not be linted.

@tesseralis
Copy link
Contributor Author

Once #25275 goes in, I think it'll make the process easier? I can definitely iterate off of it though.

@marcysutton
Copy link
Contributor

That makes sense, @tesseralis. Thanks for the follow-up and thinking it through! I'll check out the PR, and comment over there.

@pvdz pvdz removed the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jun 30, 2020
pragmaticpat pushed a commit to pragmaticpat/gatsby that referenced this pull request Apr 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants