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.

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

Doc strings are missing on several functions. #720

Open
jmiah717 opened this issue Dec 4, 2024 · 2 comments
Open

Doc strings are missing on several functions. #720

jmiah717 opened this issue Dec 4, 2024 · 2 comments

Comments

@jmiah717
Copy link

jmiah717 commented Dec 4, 2024

Is your feature request related to a problem? Please describe.
It is more difficult to understand what functions are doing without the documentation strings.

Describe the solution you'd like
Add docstrings to several functions that are currently missing docstrings.

Describe alternatives you've considered
Leaving them as is.

Additional context
None needed, many functions do not have doc strings and I propose adding at least several of them in.

@jmiah717
Copy link
Author

jmiah717 commented Dec 4, 2024

I have done a short PR to address some of these.
#721

@johnbumgarner
Copy link

Take a look at the usage documentation that I wrote for PyShark. LMK how I can improve the documentation to address how functions work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants