[9413] Conch documentation fixes #991
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
wiml
commented
Apr 6, 2018
wiml
commented
- There is an associated ticket in Trac: https://twistedmatrix.com/trac/ticket/9413
- The changes pass minimal style checks
- I have created a newsfragment
- No changes to behavior or the automated tests.
Codecov Report
@@ Coverage Diff @@
## trunk #991 +/- ##
==========================================
- Coverage 91.84% 91.49% -0.36%
==========================================
Files 844 842 -2
Lines 150593 149575 -1018
Branches 13141 13089 -52
==========================================
- Hits 138318 136858 -1460
- Misses 10178 10605 +427
- Partials 2097 2112 +15 |
|
This PR doesn't change any code (only docstrings), so I think the codecov failure is spurious. |
markrwilliams
approved these changes
Apr 8, 2018
There was a problem hiding this comment.
Thanks for improving conch's documentation!
I agree that the Codecov failure is spurious. I've pushed this to a branch so the builders will run on it and this can pass all required checks.
Feel free to address the review comments asking when methods can return None in a follow up PR.
Thanks again!
src/twisted/conch/interfaces.py
Outdated
|
|
||
| @type channelType: L{str} | ||
| @param channelType: The requested channel type | ||
| @type channelType: L{bytes} |
There was a problem hiding this comment.
Whoops! This certainly appears to be bytes. Thanks for fixing the type here!
src/twisted/conch/interfaces.py
Outdated
| @param subsystem: The name of the subsystem being requested | ||
| @type subsystem: L{bytes} | ||
| @param data: Additional request data (often nothing) | ||
| @type data: L{bytes} |
There was a problem hiding this comment.
👍 This is patently binary data.
| @type data: L{str} | ||
| @rtype: subclass of L{SSHChannel}/L{tuple} | ||
| @param data: Additional request data | ||
| @type data: L{bytes} |
There was a problem hiding this comment.
👍 Also binary data (from ssh_CHANNEL_OPEN).
src/twisted/conch/interfaces.py
Outdated
|
|
||
| We return a L{Protocol}. | ||
| @param subsystem: The name of the subsystem being requested | ||
| @type subsystem: L{bytes} |
| @type subsystem: L{bytes} | ||
| @param data: Additional request data (often nothing) | ||
| @type data: L{bytes} | ||
| @rtype: L{Protocol} or L{None} |
| @rtype: subclass of L{SSHChannel}/L{tuple} | ||
| @param data: Additional request data | ||
| @type data: L{bytes} | ||
| @rtype: a subclass of L{SSHChannel} or L{None} |
|
I added a few sentences to explain the |
|
The Fedora buildbot is failing with nonsense. o.O Clearly nothing to do with this change. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.