docs: typo cleanups for docs #16374

nschonni · 2022-10-02T00:06:04Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x ] Other, please explain:

What changes did you make? (Give an overview)

Fix some minor typos in the JSDocs
Fix typos/missing hyphens in some MD docs
Correct bad CSS value/typo
Correct UK spelling of "behaviour" that is shown as US spelling "behavior" in intellisense.

Is there anything you'd like reviewers to focus on?

These could be split out to separate PRs, but I just kept the commits separate for now.

netlify · 2022-10-02T00:06:08Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`6009354`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/6338d5ee0a695d0008515006
😎 Deploy Preview	https://deploy-preview-16374--docs-eslint.netlify.app/user-guide/configuring/configuration-files-new
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

snitin315

LGTM. Changing the type to docs since there is a user-facing change.

snitin315 · 2022-10-02T01:38:03Z

docs/src/assets/js/search.js

@@ -164,7 +164,7 @@ document.addEventListener('keydown', function (e) {
    if ((e.metaKey || e.ctrlKey) && e.key === 'k') {
        e.preventDefault();
        searchInput.focus();
-        document.querySelector('.search').scrollIntoView({ behaviour: "smooth", block: "start" });
+        document.querySelector('.search').scrollIntoView({ behavior: "smooth", block: "start" });


Yeah, it should be behavior

nschonni · 2022-10-02T01:41:51Z

docs/src/assets/scss/components/search.scss

@@ -70,7 +70,7 @@
    width: 100%;
    border-radius: 0 0 var(--border-radius) var(--border-radius);
    border: 1px solid var(--divider-color);
-    position: rekative;
+    position: relative;


Was going to try running stylelint to see if there is any other odd ones later

We have a similar PR open #16226

bmish · 2022-10-03T14:47:17Z

Nice! How did you do this by the way? I detected mistakes with cspell a while ago: #12861

nschonni · 2022-10-03T14:52:16Z

I've got a local script to regerate the project-files.txt, but you can see the local config I used here https://gist.github.com/nschonni/265577f3d51e1b1eea57e4da76263819. It's not really cleaned up, but I could PR something if you want

nschonni · 2022-10-03T14:54:26Z

This is my local git alias I use spell = "!git add project-words.txt && cspell --no-progress --words-only --unique \"**\" > project-words.txt && sort -o project-words.txt project-words.txt", although the sort call doesn't work correctly. I just then scan down the list to see the issues, or on repos I've done this, use the diff view to quickly scan just the newly added words in the text file after sorting it in VSCode

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.24.0` -> `8.25.0`](https://renovatebot.com/diffs/npm/eslint/8.24.0/8.25.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.25.0`](https://github.com/eslint/eslint/releases/tag/v8.25.0) [Compare Source](eslint/eslint@v8.24.0...v8.25.0) #### Features - [`173e820`](eslint/eslint@173e820) feat: Pass --max-warnings value to formatters ([#16348](eslint/eslint#16348)) (Brandon Mills) - [`6964cb1`](eslint/eslint@6964cb1) feat: remove support for ignore files in FlatESLint ([#16355](eslint/eslint#16355)) (Milos Djermanovic) - [`1cc4b3a`](eslint/eslint@1cc4b3a) feat: `id-length` counts graphemes instead of code units ([#16321](eslint/eslint#16321)) (Sosuke Suzuki) #### Documentation - [`90c6028`](eslint/eslint@90c6028) docs: Conflicting fixes ([#16366](eslint/eslint#16366)) (Ben Perlmutter) - [`5a3fe70`](eslint/eslint@5a3fe70) docs: Add VS to integrations page ([#16381](eslint/eslint#16381)) (Maria José Solano) - [`49bd1e5`](eslint/eslint@49bd1e5) docs: remove unused link definitions ([#16376](eslint/eslint#16376)) (Nick Schonning) - [`3bd380d`](eslint/eslint@3bd380d) docs: typo cleanups for docs ([#16374](eslint/eslint#16374)) (Nick Schonning) - [`b3a0837`](eslint/eslint@b3a0837) docs: remove duplicate words ([#16378](eslint/eslint#16378)) (Nick Schonning) - [`a682562`](eslint/eslint@a682562) docs: add `BigInt` to `new-cap` docs ([#16362](eslint/eslint#16362)) (Sosuke Suzuki) - [`f6d57fb`](eslint/eslint@f6d57fb) docs: Update docs README ([#16352](eslint/eslint#16352)) (Ben Perlmutter) - [`7214347`](eslint/eslint@7214347) docs: fix logical-assignment-operators option typo ([#16346](eslint/eslint#16346)) (Jonathan Wilsson) #### Chores - [`1f78594`](eslint/eslint@1f78594) chore: upgrade [@eslint/eslintrc](https://github.com/eslint/eslintrc)[@1](https://github.com/1).3.3 ([#16397](eslint/eslint#16397)) (Milos Djermanovic) - [`8476a9b`](eslint/eslint@8476a9b) chore: Remove CODEOWNERS ([#16375](eslint/eslint#16375)) (Nick Schonning) - [`720ff75`](eslint/eslint@720ff75) chore: use "ci" for Dependabot commit message ([#16377](eslint/eslint#16377)) (Nick Schonning) - [`42f5479`](eslint/eslint@42f5479) chore: bump actions/stale from 5 to 6 ([#16350](eslint/eslint#16350)) (dependabot\[bot]) - [`e5e9e27`](eslint/eslint@e5e9e27) chore: remove `jsdoc` dev dependency ([#16344](eslint/eslint#16344)) (Milos Djermanovic) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1577 Reviewed-by: crapStone <crapstone@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

nschonni added 3 commits October 1, 2022 20:01

docs: typos in comments/JSDocs

d4da0ab

fix: bad CSS position value rekative

3fc1bfa

fix: UK spelling of behaviour for ScrollOption

6009354

eslint-github-bot bot added triage An ESLint team member will look at this issue soon chore This change is not user-facing labels Oct 2, 2022

snitin315 approved these changes Oct 2, 2022

View reviewed changes

snitin315 changed the title ~~chore: Typo cleanups for docs~~ docs: typo cleanups for docs Oct 2, 2022

eslint-github-bot bot added the documentation Relates to ESLint's documentation label Oct 2, 2022

snitin315 added accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Oct 2, 2022

snitin315 merged commit 3bd380d into eslint:main Oct 2, 2022

nschonni commented Oct 2, 2022

View reviewed changes

nschonni deleted the docs-typos branch October 2, 2022 01:42

sync-by-unito bot mentioned this pull request Oct 10, 2022

build(deps-dev): bump eslint from 8.20.0 to 8.25.0 SmartTokenLabs/token-negotiator#420

Merged

moul-bot mentioned this pull request Oct 10, 2022

chore(deps-dev): bump eslint from 7.32.0 to 8.25.0 in /js berty/berty#4459

Closed

eslint-github-bot bot locked and limited conversation to collaborators Apr 1, 2023

eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Apr 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: typo cleanups for docs #16374

docs: typo cleanups for docs #16374

nschonni commented Oct 2, 2022 •

edited

netlify bot commented Oct 2, 2022 •

edited

snitin315 left a comment

snitin315 Oct 2, 2022

nschonni Oct 2, 2022

snitin315 Oct 2, 2022

bmish commented Oct 3, 2022 •

edited

nschonni commented Oct 3, 2022

nschonni commented Oct 3, 2022

docs: typo cleanups for docs #16374

docs: typo cleanups for docs #16374

Conversation

nschonni commented Oct 2, 2022 • edited

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

netlify bot commented Oct 2, 2022 • edited

✅ Deploy Preview for docs-eslint ready!

snitin315 left a comment

Choose a reason for hiding this comment

snitin315 Oct 2, 2022

Choose a reason for hiding this comment

nschonni Oct 2, 2022

Choose a reason for hiding this comment

snitin315 Oct 2, 2022

Choose a reason for hiding this comment

bmish commented Oct 3, 2022 • edited

nschonni commented Oct 3, 2022

nschonni commented Oct 3, 2022

nschonni commented Oct 2, 2022 •

edited

netlify bot commented Oct 2, 2022 •

edited

bmish commented Oct 3, 2022 •

edited