search

kbr / fritzconnection

Python-Tool to communicate with the AVM Fritz!Box by the TR-064 protocol and the AHA-HTTP-Interface
MIT License
303 stars 59 forks source link

Orthographic improvements #131

Closed 4ch1m closed 2 years ago

4ch1m commented 2 years ago

Hey there,

I fixed some typos and made a few other improvements regarding wording or english grammar in general. The most "severe" one should be the refactoring of all usages of informations; which occured in both comments/documentation and function-/variable-names.

Information is a mass noun. It has no plural form. Normally this wouldn't be a big deal. But since this is a general library, imho it should use proper grammar.

Would be nice if you could review my changes and merge the PR.

Again... thanks a lot!

kbr commented 2 years ago

I'm surprised that, beside the information/s systematic mistake, in the 10+ years of this library there are much fewer errors and typos than I've ever expected :)

Covering 25 files this is a giant pull request I normally would reject because of the large diff. On the other hand I like the idea to clean up the grammar – especially regarding the time you invested (and considering that AVM may improve market share in english native speaking countries).

After checking the changes I see no obvious problems. Did you run the tests before committing?

4ch1m commented 2 years ago

I struggled with myself, deciding if I should create this PR. I'm fully aware that these changes might seem pedantic or nitpicky. :nerd_face: But after working quite a while with this library I just couldn't resist.

Did you run the tests before committing?

Yes, of course. :heavy_check_mark: I also made sure the deprecation warnings give a hint to the new/correctly spelled methods.

kbr commented 2 years ago

I'm fully aware that these changes might seem pedantic or nitpicky. 🤓

That was my first impression ;) But after reading the diffs it feels more like an overdue proofreading.