Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add typing hints #27

Closed
brainelectronics opened this issue Nov 12, 2022 · 1 comment
Closed

Add typing hints #27

brainelectronics opened this issue Nov 12, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation internal Internal change, not affecting distribution
Milestone
Documentation

Comments

@brainelectronics
Copy link
Owner

Add typing hints to all files being used in this lib
@brainelectronics brainelectronics added documentation Improvements or additions to documentation internal Internal change, not affecting distribution labels Nov 12, 2022
brainelectronics added a commit that referenced this issue Nov 19, 2022
@brainelectronics
add typing hints and doc strings to functions file functions, see #27
ca4a0ee
brainelectronics added a commit that referenced this issue Nov 19, 2022
@brainelectronics
add doc strings for some function in functions.py, see #27
ac98dcc
brainelectronics added a commit that referenced this issue Nov 20, 2022
@brainelectronics
add typing hints and some doc strings to serial.py, see #27
f0e39c4
brainelectronics added a commit that referenced this issue Nov 20, 2022
@brainelectronics
add typing hints and some doc strings to tcp.py, see #27
6aaecbf
brainelectronics added a commit that referenced this issue Nov 30, 2022
@brainelectronics
fix typing hints of some TCP module functions, relates to #27
9e89423
brainelectronics added a commit that referenced this issue Dec 2, 2022
@brainelectronics
fix typing hints in TCP, see #27
13c2dce
@brainelectronics brainelectronics mentioned this issue Dec 2, 2022
Merged
@brainelectronics
Copy link
Owner Author

Ensure List, Union, Tuple and others are subscritable otherwise an error might be raised.

class _Subscriptable:

    def __getitem__(self, sub):
        return None

_subscriptable = _Subscriptable()

List = _subscriptable
Union = _subscriptable
# ...

@brainelectronics brainelectronics added this to the Documentation milestone Dec 8, 2022
brainelectronics added a commit that referenced this issue Dec 8, 2022
@brainelectronics
make Dict, Tuple, List, Optional and Union subscriptable, relates to …
2b8c759 
…docs generation, contributes to #27
@brainelectronics brainelectronics mentioned this issue Dec 13, 2022
Closed
brainelectronics added a commit that referenced this issue Dec 17, 2022
@brainelectronics
add doc strings and typing hints in common module, see #27
cb36e4f
brainelectronics added a commit that referenced this issue Dec 17, 2022
@brainelectronics
add docstrings and summary for modbus module, see also #27
ed0f82d
brainelectronics added a commit that referenced this issue Dec 17, 2022
@brainelectronics
add doc strings and typing hints in serial module, see #27
ae6ef0f
brainelectronics added a commit that referenced this issue Dec 17, 2022
@brainelectronics
add doc strings and typing hints in tcp module, see #27
0e315ac
brainelectronics added a commit that referenced this issue Dec 17, 2022
@brainelectronics
add doc strings and typing hints in functions module, see #27
c6c61cb
@brainelectronics brainelectronics mentioned this issue Dec 17, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation internal Internal change, not affecting distribution
Projects
None yet
Milestone
Documentation
Development

No branches or pull requests
1 participant
@brainelectronics