hardbyte / hardbyte/python-can

Adding Additional Documentation or Updating Documentation As Needed

Open
#1,826 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
1.6k
Forks
697
PR merge metrics
No merged PRs in 30d

Description

### Is your feature request related to a problem? Please describe.
While most functions have appropriate documentation, it could help for consistency and clarity for additional functions that currently do not have documentation, to have documentation. Any old/outdated documentation can also be updated as necessary.

### Describe the solution you'd like
I can update any necessary documentation and add some additional documentation in missing areas. If any additional suggestions are requested or required, I can look into those as well.

### Describe alternatives you've considered
Helping with something else more necessary that can also be done in a very short time-span (~week).

### Additional context
I am opening and exploring this issue as I am in an open-source software summer course, please let me know if issue is not necessary/needed and I can explore other potential issues.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.