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

Fixed docstring of return value of the srloop and srploop functions #4060

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ronymunitz
Copy link

Fixed return value of the srloop and srploop functions. The return value was updated in the comment, but not in the docstring.

@ronymunitz ronymunitz changed the title Fixed return value of the srloop and srploop functions Fixed docstring of return value of the srloop and srploop functions Jul 10, 2023
guedou
guedou previously approved these changes Jul 10, 2023
@guedou
Copy link
Member

guedou commented Jul 10, 2023

Thanks for this PR!

@codecov
Copy link

codecov bot commented Jul 10, 2023

Codecov Report

Merging #4060 (32ec515) into master (6dbdc37) will increase coverage by 0.00%.
Report is 199 commits behind head on master.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4060   +/-   ##
=======================================
  Coverage   81.95%   81.95%           
=======================================
  Files         327      327           
  Lines       75540    75554   +14     
=======================================
+ Hits        61911    61923   +12     
- Misses      13629    13631    +2     
Files Coverage Δ
scapy/sendrecv.py 87.95% <ø> (-0.16%) ⬇️

... and 10 files with indirect coverage changes

@polybassa
Copy link
Contributor

Retrigger tests

@polybassa polybassa closed this Jul 10, 2023
@polybassa polybassa reopened this Jul 10, 2023
@ronymunitz
Copy link
Author

Added another fix in the docstring, regarding the AsyncSniffer/sniff docstring.

@polybassa polybassa requested a review from guedou November 1, 2023 05:47
@gpotter2
Copy link
Member

gpotter2 commented Nov 9, 2023

So I doubt this is very useful. This is basically only ever shown in help(), in which case I would much rather have a user friendly typing. Generally, the current docstrings is also very unhelpful so I believe it would be better to simply redo it using words, and sphinx :param: tags.

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

Successfully merging this pull request may close these issues.

None yet

4 participants