Skip to content

Update modal handling documents#975

Merged
seratch merged 1 commit into
slackapi:mainfrom
seratch:update-modal-docs
Mar 5, 2021
Merged

Update modal handling documents#975
seratch merged 1 commit into
slackapi:mainfrom
seratch:update-modal-docs

Conversation

@seratch

@seratch seratch commented Mar 5, 2021

Copy link
Copy Markdown
Contributor

Summary

As I mentioned at #970 (comment), the current documents about modals in this project are misleading. We don't recommend using views.update API method in response to view_submission requests (actually, it does not work properly). Therefore, in this pull request, I've added a section explaining how to use response_action type and view in HTTP response.

Category (place an x in each of the [ ])

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.models (UI component builders)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.rtm (RTM client)
  • slack_sdk.signature (Request Signature Verifier)
  • /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 x in each [ ])

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python setup.py validate after making the changes.

@seratch seratch added docs M-T: Documentation work only web-client Version: 3x labels Mar 5, 2021
@seratch seratch added this to the 3.4.3 milestone Mar 5, 2021
@seratch seratch self-assigned this Mar 5, 2021
@codecov

codecov Bot commented Mar 5, 2021

Copy link
Copy Markdown

Codecov Report

Merging #975 (0f8c143) into main (dac21c3) will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #975      +/-   ##
==========================================
+ Coverage   87.33%   87.34%   +0.01%     
==========================================
  Files          94       94              
  Lines        8541     8541              
==========================================
+ Hits         7459     7460       +1     
+ Misses       1082     1081       -1
Impacted Files Coverage Δ
slack_sdk/socket_mode/websocket_client/__init__.py 88.46% <0.00%> (-1.54%) ⬇️
slack_sdk/socket_mode/client.py 76.99% <0.00%> (+2.65%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dac21c3...0f8c143. Read the comment docs.

@seratch

seratch commented Mar 5, 2021

Copy link
Copy Markdown
Contributor Author

Let me merge this now but let me know if you have comments at any time!

@seratch seratch merged commit 0f5e0f0 into slackapi:main Mar 5, 2021
@seratch seratch deleted the update-modal-docs branch March 5, 2021 23:20
@seratch seratch modified the milestones: 3.4.3, 3.5.0 Mar 30, 2021
@seratch seratch mentioned this pull request Apr 10, 2021
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mwbrooks mwbrooks Awaiting requested review from mwbrooks
@stevengill stevengill Awaiting requested review from stevengill
@misscoded misscoded Awaiting requested review from misscoded

Assignees

@seratch seratch

Labels

docs M-T: Documentation work only Version: 3x web-client

Projects

None yet

Milestone

3.5.0

Development

Successfully merging this pull request may close these issues.

1 participant

@seratch