pu2clr / SI4735

SI473X Library for Arduino
MIT License
581 stars 169 forks source link

Typos in function names? #13

Closed ha5dzs closed 2 years ago

ha5dzs commented 2 years ago

Describe the bug Some of the abbreviations in function names appear to be misspelled.

To Reproduce Look at he following functions:

setSBBSidebandCutoffFilter()
setSeekAmSrnThreshold()
setSeekFmSrnThreshold()

Expected behavior I am assuming this is not intentional. Please disregard if it is.

Correct function names:

setSSBSidebandCutoffFilter()
setSeekAmSNRThreshold()
setSeekFmSNRThreshold()

Since a lot of people use this code, it would probably be the easiest to make some #defines that point to the correct function name. Also, the AVR C-compiler supports throwing warning messages during compilation time, so they can be added as well.

Screenshots [not needed]

Please, add the following information):

Additional context I don't think it needs any more elaboration.

Otherwise, congrats on this huge amount of code written, you literally started a revolution! :)

pu2clr commented 2 years ago

Thanks. I have just to fixed the names by using inline statement. For example: void inline setSeekAmSNRThreshold(uint16_t value) { setSeekAmSrnThreshold(value); }; // Fixing the function name

I kept the wrong name due to old sketches (legacy). This way the old sketches that use the wrong name will work too. Now you can call setSSBSidebandCutoffFilter() setSeekAmSNRThreshold() setSeekFmSNRThreshold()

Thanks again. Ricardo.