content icon indicating copy to clipboard operation
content copied to clipboard

Reorganize custom dictionaries, better spell checking infra

Open Josh-Cena opened this issue 1 year ago • 7 comments

This should be merged after my fleet of typo fix PRs.

This PR splits our custom dictionaries by topic, making them easier to maintain and inspect. It could also allow for more granular options in the future, such as whether each one should provide suggestions, or whether they should be case-sensitive.

@OnkarRuikar @bsmth

Josh-Cena avatar Oct 07 '24 23:10 Josh-Cena

Give me 2-3 days.

OnkarRuikar avatar Oct 08 '24 05:10 OnkarRuikar

command [filePaths...]

You are using both ellipsis and plural from of the word.

How to denote at least one file is required? command <filePath> [filePath...]? I think command [filePath]... does that.

OnkarRuikar avatar Oct 09 '24 05:10 OnkarRuikar

Huh, the GH actions shell does not automatically expand glob patterns. That's inconvenient.

Josh-Cena avatar Oct 09 '24 05:10 Josh-Cena

You are using both ellipsis and plural from of the word.

How to denote at least one file is required? command <filePath> [filePath...]? I think command [filePath]... does that.

This is the description format as used by commander.js

Josh-Cena avatar Oct 09 '24 05:10 Josh-Cena

In writing docs we need to explain following points:

  • when to use cSpell inline ignore comments in content
  • the purpose of each dictionary
  • nuances like cities are to be put in cultural-words but towns and places in proper-name. We don't want to suggest small towns and places but want countries and cities etc.

I am waiting on content fixes to merge to check regex and other codes.

OnkarRuikar avatar Oct 09 '24 08:10 OnkarRuikar

Huh, the GH actions shell does not automatically expand glob patterns. That's inconvenient.

You can specify shell to a task:

jobs:
  name-of-job:
    runs-on: ubuntu-latest
    steps:
      - name: Hello world
        shell: pwsh
        run: |
          write-output "Hello World"

steps:
  - name: Display the path
    run: |
      import os
      print(os.environ['PATH'])
    shell: python

steps:
  - name: Display the path
    run: echo $PATH
    shell: bash

OnkarRuikar avatar Oct 09 '24 08:10 OnkarRuikar

This pull request has merge conflicts that must be resolved before it can be merged.

github-actions[bot] avatar Oct 15 '24 15:10 github-actions[bot]

This pull request has merge conflicts that must be resolved before it can be merged.

github-actions[bot] avatar Oct 28 '24 03:10 github-actions[bot]

This should be merged after my fleet of typo fix PRs.

Already looking promising, nice work 👍🏻

bsmth avatar Oct 28 '24 09:10 bsmth

Preview URLs

External URLs (1)

URL: /en-US/docs/MDN/Writing_guidelines/Writing_style_guide Title: Writing style guide

(comment last updated: 2024-10-31 02:20:13)

github-actions[bot] avatar Oct 28 '24 15:10 github-actions[bot]

In writing docs we need to explain following points:

Which docs are you referring to? The comments and descriptions in the cSpell config?

Josh-Cena avatar Oct 28 '24 15:10 Josh-Cena

Will merge once @OnkarRuikar also gives a thumbsup

Josh-Cena avatar Oct 30 '24 03:10 Josh-Cena

Great, let's go!

Josh-Cena avatar Oct 31 '24 02:10 Josh-Cena

Well done 👏🏻

bsmth avatar Oct 31 '24 09:10 bsmth