Skip to content

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

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

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

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.

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:31
@mwbrooks mwbrooks self-assigned this Oct 5, 2020
@mwbrooks mwbrooks linked an issue Oct 5, 2020 that may be closed by this pull request
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 5, 2020

Codecov Report

Merging #831 into main will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #831   +/-   ##
=======================================
  Coverage   87.29%   87.29%           
=======================================
  Files          30       30           
  Lines        3761     3761           
  Branches      337      337           
=======================================
  Hits         3283     3283           
  Misses        329      329           
  Partials      149      149           

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 5a2c80e...f3c974d. Read the comment docs.

@seratch
Copy link
Copy Markdown
Contributor

seratch commented Oct 5, 2020

@mwbrooks Thanks for improving this! LGTM. Can you make the same PR for the v3 branch?

@mwbrooks
Copy link
Copy Markdown
Member Author

mwbrooks commented Oct 5, 2020

@seratch can do! Just sent a PR for the v3 docs as #832

@seratch seratch merged commit f3053d6 into slackapi:main 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.

No response when sending the bot a direct message

2 participants