PowerToys icon indicating copy to clipboard operation
PowerToys copied to clipboard

Added markdown file for mouse without borders documentation

Open ckirby19 opened this issue 1 year ago • 9 comments

Summary of the Pull Request

Added documentation in the dev docs section, describing the status codes for the Mouse Without Borders modules

PR Checklist

  • [X] Closes: #26640
  • [X] Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
  • [ ] Tests: No tests for this ticket
  • [X ] Localization: All end user facing strings can be localized
  • [X] Dev docs: Added/updated
  • [ ] New binaries: No new binaries
  • [X] Documentation updated: If checked, please file a pull request on our docs repo and link it here: https://github.com/MicrosoftDocs/windows-dev-docs/pull/4815

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

ckirby19 avatar Jan 09 '24 23:01 ckirby19

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

mousewithoutborders

Previously acknowledged words that are now absent applicationframehost Kazakhstani qps Tenge TKey TValue unescape 🫥
To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:ckirby19/PowerToys.git repository on the feature/document-mouse-without-borders-colors branch (:information_source: how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/PowerToys/actions/runs/7467946406/attempts/1'
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary

This includes both expected items (1849) from .github/actions/spell-check/expect.txt and unrecognized words (1)

Dictionary Entries Covers Uniquely
cspell:r/src/r.txt 543 1 1
cspell:cpp/src/people.txt 23 1
cspell:cpp/src/ecosystem.txt 51 1

Consider adding them (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

      with:
        extra_dictionaries:
          cspell:r/src/r.txt
          cspell:cpp/src/people.txt
          cspell:cpp/src/ecosystem.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

check_extra_dictionaries: ''
Errors (1)

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

:x: Errors Count
:x: check-file-path 1

See :x: Event descriptions for more information.

If the flagged items are :exploding_head: false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it, try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

github-actions[bot] avatar Jan 09 '24 23:01 github-actions[bot]

@microsoft-github-policy-service agree

ckirby19 avatar Jan 09 '24 23:01 ckirby19

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

mousewithoutborders

Previously acknowledged words that are now absent applicationframehost Kazakhstani qps Tenge TKey TValue unescape 🫥
To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:ckirby19/PowerToys.git repository on the feature/document-mouse-without-borders-colors branch (:information_source: how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/PowerToys/actions/runs/7480936874/attempts/1'
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary

This includes both expected items (1849) from .github/actions/spell-check/expect.txt and unrecognized words (1)

Dictionary Entries Covers Uniquely
cspell:r/src/r.txt 543 1 1
cspell:cpp/src/people.txt 23 1
cspell:cpp/src/ecosystem.txt 51 1

Consider adding them (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

      with:
        extra_dictionaries:
          cspell:r/src/r.txt
          cspell:cpp/src/people.txt
          cspell:cpp/src/ecosystem.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

check_extra_dictionaries: ''
Errors (1)

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

:x: Errors Count
:x: check-file-path 1

See :x: Event descriptions for more information.

If the flagged items are :exploding_head: false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it, try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

github-actions[bot] avatar Jan 10 '24 21:01 github-actions[bot]

Can anyone give me a hand with the spell checking fail in this PR pipeline? I am not really sure what is triggering it to fail

ckirby19 avatar Jan 14 '24 22:01 ckirby19

Can anyone give me a hand with the spell checking fail in this PR pipeline? I am not really sure what is triggering it to fail

The file path is triggering the spell check block. Maybe we can name it mouse-without-borders.md or MouseWithoutBorders.md.

htcfreek avatar Jan 15 '24 20:01 htcfreek

adding the filename to the spellcheck file is the simplest and is in line with all the other file names.

Jay-o-Way avatar Jan 16 '24 11:01 Jay-o-Way

Where can I find this spellcheck file to add mousewithoutborders to it?

ckirby19 avatar Jan 16 '24 23:01 ckirby19

Where can I find this spellcheck file to add mousewithoutborders to it?

It's in ".github/actions/spell-check/expect.txt"

jaimecbernardo avatar Jan 17 '24 15:01 jaimecbernardo

Please use https://github.com/microsoft/PowerToys/blob/main/.github%2Factions%2Fspell-check%2Fallow%2Fnames.txt instead of expect.txt

Jay-o-Way avatar Jan 17 '24 16:01 Jay-o-Way

Added to spell check now

ckirby19 avatar Jan 19 '24 10:01 ckirby19