Draft
Conversation
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.
Motivation
The v3 SDK modules (
linebot.v3.messaging,linebot.v3.audience, etc.) have no Sphinx documentation generated, despite the v2linebotmodules being documented. Additionally, theOpenAPI generator's async template contains incorrect docstrings claiming "This method makes a synchronous HTTP request by default" in
AsyncMessagingApiand similar async classes.What's changed
Sphinx docs for v3
docs/source/linebot.v3.rstand 9 subpackage.rstfiles (messaging,audience,insight,liff,module,moduleattach,oauth,shop,webhooks)linebot.v3todocs/source/index.rsttoctreeMessagingApiandAsyncMessagingApi)Template fixes (
generator/.../python-nextgen-custom-client/)asyncio/async_api.mustache:# noqa: E501from docstring lines (kept on code lines)operationIdfallback from docstring first line:paramfield list to fix reST parsing warningsapi.mustache:# noqa: E501from docstring linesoperationIdfallback from docstring first lineRegenerated API files (23 files)
All
linebot/v3/*/api/*.pyfiles regenerated with cleaned-up docstrings.How to review
Build and preview locally: