capacitor icon indicating copy to clipboard operation
capacitor copied to clipboard

Fix typos and improve documentation across various files

Open riderx opened this issue 2 months ago • 7 comments

Corrected multiple typos and enhanced clarity in documentation throughout the codebase, ensuring consistency in variable names and comments.

I used typos-cli command to fix them and double checked by hands all was done properly

riderx avatar Nov 11 '25 20:11 riderx

This is kinda neat - let me look into it. some issues.

  • We shouldn't point to crate-ci/typos@master
    • I swore there was a workflow in here? Is that another PR I lost track of?
  • This checker seems to change github SHAs in markdown, which is not ok.
  • Also, the docs changes are no brainers, but the spelling corrections on public methods may be breaking changes. I don't actually think they are in most cases, but I need to check

markemer avatar Nov 12 '25 17:11 markemer

@markemer i will revert and add .typo.toml to ensure it doesn't do this

riderx avatar Nov 12 '25 17:11 riderx

Hey @markemer we should be all good now do you want i merge the github action check in this one as well ?

riderx avatar Nov 12 '25 18:11 riderx

Hey @markemer we should be all good now do you want i merge the github action check in this one as well ?

That one is a bigger deal - but this one should be an easy sell.

markemer avatar Nov 12 '25 18:11 markemer

The GitHub workflow was made only in the doc repo as PR https://github.com/ionic-team/capacitor-docs/pull/481 I made it here as separate PR as well, added at lint stage https://github.com/ionic-team/capacitor/pull/8232

riderx avatar Nov 12 '25 18:11 riderx

@markemer i fixed all comment :)

riderx avatar Nov 14 '25 01:11 riderx

hey @eric-horodyski can you review again ?

riderx avatar Nov 25 '25 04:11 riderx