scapy icon indicating copy to clipboard operation
scapy copied to clipboard

Fixed docstring of return value of the srloop and srploop functions

Open ronymunitz opened this issue 2 years ago • 5 comments

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

ronymunitz avatar Jul 10 '23 02:07 ronymunitz

Thanks for this PR!

guedou avatar Jul 10 '23 05:07 guedou

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%) :arrow_down:

... and 10 files with indirect coverage changes

codecov[bot] avatar Jul 10 '23 06:07 codecov[bot]

Retrigger tests

polybassa avatar Jul 10 '23 06:07 polybassa

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

ronymunitz avatar Jul 14 '23 06:07 ronymunitz

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.

gpotter2 avatar Nov 09 '23 18:11 gpotter2