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

Detect typos in Markdown documents (2nd attempt) #9347

Merged
merged 2 commits into from
Sep 14, 2021

Conversation

electrocucaracha
Copy link
Collaborator

Problem

Typos and grammar errors are not easy to detect, specially when documentation is created with standard editors. This becomes harder for non-native English speakers.

Change overview

This change fixes some of the current existing typos in the markdown documents as well as provides a set of GitHub actions for reviewing new changes and/or additions in documents.

Testing

The GitHub actions will only be triggered when changes on markdown are detected.

@electrocucaracha electrocucaracha force-pushed the fix_typos branch 2 times, most recently from b9191c0 to 840a37f Compare September 7, 2021 19:19
@woody-apple
Copy link
Contributor

@electrocucaracha This doesn't pass restyled, looks like it's struggling with the .github workflow, and the wordlist. How did we seed this wordlist with things like aabbccddeeff, also - can you check restyle here locally to see if this passes for you?

Signed-off-by: Victor Morales <v.morales@samsung.com>
Signed-off-by: Victor Morales <v.morales@samsung.com>
@github-actions
Copy link

github-actions bot commented Sep 8, 2021

Size increase report for "esp32-example-build" from 6c9042e

File Section File VM
chip-shell.elf .flash.text 48 48
chip-ipv6only-app.elf .flash.text 172 172
chip-bridge-app.elf .flash.text -48 -48
Full report output
BLOAT REPORT

Files found only in the build output:
    report.csv

Comparing ./master_artifact/chip-lock-app.elf and ./pull_artifact/chip-lock-app.elf:

sections,vmsize,filesize

Comparing ./master_artifact/chip-shell.elf and ./pull_artifact/chip-shell.elf:

sections,vmsize,filesize
.flash.text,48,48
[Unmapped],0,-48

Comparing ./master_artifact/chip-ipv6only-app.elf and ./pull_artifact/chip-ipv6only-app.elf:

sections,vmsize,filesize
[Unmapped],0,3924
.flash.text,172,172

Comparing ./master_artifact/chip-temperature-measurement-app.elf and ./pull_artifact/chip-temperature-measurement-app.elf:

sections,vmsize,filesize

Comparing ./master_artifact/chip-pigweed-app.elf and ./pull_artifact/chip-pigweed-app.elf:

sections,vmsize,filesize

Comparing ./master_artifact/chip-persistent-storage.elf and ./pull_artifact/chip-persistent-storage.elf:

sections,vmsize,filesize

Comparing ./master_artifact/chip-bridge-app.elf and ./pull_artifact/chip-bridge-app.elf:

sections,vmsize,filesize
[Unmapped],0,48
.flash.text,-48,-48

Comparing ./master_artifact/chip-all-clusters-app.elf and ./pull_artifact/chip-all-clusters-app.elf:

sections,vmsize,filesize


@andy31415 andy31415 merged commit 9e8d268 into project-chip:master Sep 14, 2021
@electrocucaracha electrocucaracha deleted the fix_typos branch September 16, 2021 15:26
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.

7 participants