Skip to content

[#830] Clarify channel type in v3 docs for Running the App#832

Merged
seratch merged 1 commit intoslackapi:v3from
mwbrooks:830-clarify-running-app-docs-v3
Oct 5, 2020
Merged

[#830] Clarify channel type in v3 docs for Running the App#832
seratch merged 1 commit intoslackapi:v3from
mwbrooks:830-clarify-running-app-docs-v3

Conversation

@mwbrooks
Copy link
Copy Markdown
Member

@mwbrooks mwbrooks commented Oct 5, 2020

Summary

In issue #830, a developer tried to DM the bot and didn't
receive a response because the 'message.im' event was not used.

This tutorial only uses 'message.channels', so the bot must be
invited to a public channel to receive the "start" message.

This commit clarifies that the bot must be invited to a public channel
for the v3 docs.

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

  • slack.web.WebClient (Web API client)
  • slack.webhook.WebhookClient (Incoming Webhook, response_url sender)
  • slack.web.classes (UI component builders)
  • slack.rtm.RTMClient (RTM client)
  • Documents
  • Others

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.

In issue slackapi#830, a developer tried to DM the bot and didn't
receive a response because the 'message.im' event was not used.

This tutorial only uses 'message.channels', so the bot must be
invited to a public channel to receive the "start" message.

This commit clarifies that the bot must be invited to a public channel.
@mwbrooks mwbrooks added the docs M-T: Documentation work only label Oct 5, 2020
@mwbrooks mwbrooks requested review from seratch and shaydewael October 5, 2020 21:57
@mwbrooks mwbrooks self-assigned this Oct 5, 2020
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 5, 2020

Codecov Report

Merging #832 into v3 will decrease coverage by 10.65%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##               v3     #832       +/-   ##
===========================================
- Coverage   87.25%   76.59%   -10.66%     
===========================================
  Files          30       35        +5     
  Lines        3585     3128      -457     
  Branches      316        0      -316     
===========================================
- Hits         3128     2396      -732     
- Misses        325      732      +407     
+ Partials      132        0      -132     
Impacted Files Coverage Δ
slack/web/classes/attachments.py
slack/web/client.py
slack/webhook/__init__.py
slack/signature/__init__.py
slack/web/deprecation.py
slack/rtm/client.py
slack/web/__init__.py
slack/webhook/internal_utils.py
slack/web/classes/interactions.py
slack/web/async_internal_utils.py
... and 55 more

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 042bb05...ef67633. Read the comment docs.

@seratch seratch merged commit 0df7596 into slackapi:v3 Oct 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs M-T: Documentation work only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants