adding type information

[FoamyGuy]

resolves #21.

The main thing I am somewhat uncertain of is the * arg in the constructor here:
https://github.com/FoamyGuy/Adafruit_CircuitPython_VC0706/blob/d56a319b59a5f211617c90bb9963d03b405cc879/adafruit_vc0706.py#L93

I tried Any type but that did not seem to work. I'm not sure what the proper way to type this wildcard argument is. Perhaps leaving it untyped is standard practice? If anyone knows about this, or knows of an example where this is done in another library let me know.

[tekktrik]

* signifies that any arguments after it are keyword only! I think in this case it doesn't have a type.

Here's the relevant PEP, for reference: https://peps.python.org/pep-3102/#:~:text=Keyword%2Donly%20arguments%20are%20not,therefore%20'required%20keyword'%20arguments.

[tekktrik]

It sounds like if it were *ignore or something else it could be typed as List[Any] but the star shortcut itself doesn't have a type?

[tekktrik]

Nice! A few questions and suggestions, but otherwise looks good!

[FoamyGuy]

It sounds like if it were *ignore or something else it could be typed as List[Any] but the star shortcut itself doesn't have a type?

I'm not sure if it does. It would seem tricky though because it can represent multiple different arguments, so no single type could really describe it in all cases.

[tekktrik]

I'm not sure if it does. It would seem tricky though because it can represent multiple different arguments, so no single type could really describe it in all cases.

I think using only * means the program should raise an error if additional positional arguments are found, so theoretically, it can't be ANY type, since it being anything will raise an error, unless CircuitPython implementation deviates from the PEP. It would be like typing the / character that can be used to signify positional-only arguments (which is less commonly used I think but still valid), in that it seems more to be more of a sentinel character than an actual argument itself.

[FoamyGuy]

Interesting, I never knew about that usage of the / character. I would assume CircuitPython does follow the PEP as closely as possible because I know that is one of the primary goals is to keep compatibility with CPython whenever possible. Though I'm not 100% certain of the behavior in CircuitPython (or really CPython for that matter).

Thank you for looking this over and for explanation about the different Buffer protocols. I think I'm starting to get a better understanding of when it's appropriate to use which one.

I think I've got all of the requested changes in the latest commit. If you have another chance to take a look @tekktrik let me know if anything else is needed.

[tekktrik]

My pleasure! I think that's everything!

[tekktrik]

Looks good to me!