search

dart-lang / pub-dev

The pub.dev website
https://pub.dev
BSD 3-Clause "New" or "Revised" License
777 stars 145 forks source link

Proposal to fix spelling errors #7752

Open jsoref opened 4 months ago

jsoref commented 4 months ago

I maintain a check-spelling action and use it for various things. Sometimes I'll run it against random repositories to see how it does. In this case iterating on this repository's data enabled me to fix a long standing bug (i.e. the process gives me value, in addition, to hopefully, occasionally giving the projects to which I submit PRs value).

Anyway, the tool identified a number of misspellings you can see its report. I've excerpted the list of misspelled words (there are a handful of other grammatical fixes included in the full series):

misspelled words (93) ``` abled accross adviced alonside anlysis applicaions aquire aquisition attemps auxilliary avaiable avaliable beq brokens candiates causion charaters chuncks compatiblity compelted completetion completition configration Configuraiton Confiugure Constents Defintion deleteds dependants differnet dircetory eachother earliers elemented emojies enconding entitites experiece expirty extact Gernerate identfier indefintely Inmemory intentioanlly likley malformatted mathing Meadata metdata missmatch mulitple mulitplied occured Ofcourse orhaned paget populare prerelase priorization propergation pubilsher quering Recieve recude registery reliablity Reponses Repsonse returend seach seaprator serverside snaptshot stoppped successfull sync'ed teh Tempoarily Timout TOOD toogle topcis travese truely trusteded tryingt Uder unlikly Unqiue Verions Vicenty wether ```

If I made a PR based on https://github.com/dart-lang/pub-dev/compare/master...jsoref:spelling?expand=1, the results would be happier: https://github.com/jsoref/dart-lang-pub-dev/actions/runs/9211281686#summary-25340292881

I'm deferring creating a PR per the PR Template:

  • Larger or significant changes should be discussed in an issue before creating a PR.
isoos commented 4 months ago

Thanks for looking into this, as I've been looking at the proposed changes, I've filed #7768 that addresses many of the types in the code (mostly because I wanted to make sure that code changes are done with tool-based refactors).

The tool got many things right, but it needs review, as it got the contsents -> consents vs contents choosing the more probable one, but not applicable in that context.

Another note: in many classes we have chosen to name them like <something>Github<something> and not using capital H, as it separates it better from related (but non-github) classes. It is also closer to the Dart naming guides, and we would like to keep it that way.

Could you please re-run the tool after the PR gets merged and maybe remove the GitHub changes from its output? Once we are down to comment-based changes, the review will be quick...

jsoref commented 4 months ago

Sure. Note that the tool only flags errors. A very flawed human (me) picked all the corrections.