terranexum / OpenQGO

A generalized, open-source version of our Quantum Global Optimizer platform to solve the problem of getting anything where it needs to go.
MIT License
3 stars 2 forks source link

Start adding type annotations to QGO Nexum classes #6

Closed jimmcgaw closed 1 year ago

jimmcgaw commented 1 year ago

While combing through the code, I started adding type annotations to the class attributes and methods in a few places so I could better understand what data is flowing where.

It is not clear what version of Python this repo is pinned to; these annotations are supported in Python 3.10 and up. If it's less than that, I'll have to update to explicitly use things from the [typing](https://docs.python.org/3.7/library/typing.html) module.

Not everyone likes these kinds of type hints in their code. Please close if this doesn't add value or goes against the desired style guidelines for this repo.