Rewrite reStructuredText docstrings to use Google style#981
Merged
seratch merged 1 commit intoslackapi:mainfrom Mar 24, 2021
Merged
Rewrite reStructuredText docstrings to use Google style#981seratch merged 1 commit intoslackapi:mainfrom
seratch merged 1 commit intoslackapi:mainfrom
Conversation
seratch
commented
Mar 20, 2021
| files: Dict[str, io.BytesIO] = {}, | ||
| additional_headers: Dict[str, str] = {}, | ||
| ) -> SlackResponse: | ||
| """Performs a Slack API request and returns the result. |
Contributor
Author
There was a problem hiding this comment.
The slack package exists just for v2 backward compatibility (we will remove these in the long run). To reduce duplicated work for the future, let me delete these comments.
Codecov Report
@@ Coverage Diff @@
## main #981 +/- ##
==========================================
- Coverage 87.31% 87.30% -0.02%
==========================================
Files 94 94
Lines 8541 8541
==========================================
- Hits 7458 7457 -1
- Misses 1083 1084 +1
Continue to review full report at Codecov.
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 ap
2CAF
plied right now. Please check back later.
Summary
This pull request is preparation for #980 API document hosting.
Category (place an
xin each of the[ ])/docs-src(Documents, have you run./docs.sh?)/docs-src-v2(Documents, have you run./docs-v2.sh?)/tutorial(PythOnBoardingBot tutorial)tests/integration_tests(Automated tests for this library)Requirements (place an
xin each[ ])python setup.py validateafter making the changes.