Add /api-docs/slack_bolt/ generation#263
Merged
seratch merged 2 commits intoslackapi:mainfrom Mar 24, 2021
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## main #263 +/- ##
=======================================
Coverage 91.25% 91.25%
=======================================
Files 160 160
Lines 4983 4983
=======================================
Hits 4547 4547
Misses 436 436
Continue to review full report at Codecov.
|
seratch
commented
Mar 23, 2021
slack_bolt/__init__.py
Outdated
| @@ -1,3 +1,93 @@ | |||
| """ | |||
| ## Welcome to Bolt for Python API Document! | |||
Contributor
Author
There was a problem hiding this comment.
We will simplify this page document to just have links to key packages/classes
bd206bf to
af86eff
Compare
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
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.
This pull request updates the docstring for API document generation. The changes in this PR are:
The live preview is available at:
This pull request partially resolves #128 but we still need some additional information as with https://slack.dev/bolt-js/reference
Category (place an
xin each of the[ ])slack_bolt.Appand/or its core componentsslack_bolt.async_app.AsyncAppand/or its core componentsslack_bolt.adapter/docsRequirements (place an
xin each[ ])Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.
./scripts/install_all_and_run_tests.shafter making the changes.