Refine the docstrings are made available across all functions and classes #55
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
sdglitched
suggested changes
Nov 11, 2024
expedite/client/conn.py
Outdated
| """ | ||
| Show textual message of starting the exchange process | ||
|
|
||
| :return: |
There was a problem hiding this comment.
Please add information about the return statement of this function
expedite/view.py
Outdated
|
|
||
| :param text: |
There was a problem hiding this comment.
Add information about the parameter text in this function
expedite/view.py
Outdated
|
|
||
| def warning(message) -> None: | ||
| standard.logger.warning(style(message, fg="yellow", bold=True)) | ||
| :param text: |
There was a problem hiding this comment.
Add information about the parameter text in this function
expedite/view.py
Outdated
| """ | ||
| Show textual message in warning format | ||
|
|
||
| :param text: |
There was a problem hiding this comment.
Add information about the parameter text in this function
expedite/view.py
Outdated
| """ | ||
| Show textual message in general format | ||
|
|
||
| :param text: |
There was a problem hiding this comment.
Add information about the parameter text in this function
Signed-off-by: Akashdeep Dhar <akashdeep.dhar@gmail.com>
Signed-off-by: Akashdeep Dhar <akashdeep.dhar@gmail.com>
gridhead
force-pushed
the
cmnt
branch
2 times, most recently
from
db986f1 to
5aa68a5
Compare
sdglitched
suggested changes
Nov 11, 2024
expedite/client/bridge/room.py
Outdated
| @@ -117,28 +137,53 @@ def show_detail(self): | |||
| ) | |||
|
|
|||
| def normal_delivering_side(self): | |||
There was a problem hiding this comment.
Add typing (return type) for this function
expedite/client/bridge/util.py
Outdated
| """ | ||
| Ensure that filepath for delivering or collecting contents must exist | ||
|
|
||
| :param path: Load filepath |
There was a problem hiding this comment.
Change the parameter from path to file and adjust the description accordingly
Signed-off-by: Akashdeep Dhar <akashdeep.dhar@gmail.com>
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.
Refine the docstrings are made available across all functions and classes
Fixes #53