Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct Socket Mode package README #1193

Merged
merged 1 commit into from Mar 24, 2021
Merged

Correct Socket Mode package README #1193

merged 1 commit into from Mar 24, 2021

Conversation

slifty
Copy link
Contributor

@slifty slifty commented Mar 24, 2021

Summary

The documentation was misleading in two ways:

  1. appToken needs to be passed as a named parameter in order to be recognized.
  2. the "Send a message" example did not actually start the socketModeClient, which
    meant the process would immediately terminate.

I got hit with both issues while trying to experiment with this!

Requirements (place an x in each [ ])

The documentation was misleading in two ways:

1) appToken needs to be passed as a named parameter in order to be recognized.
2) the "Send a message" example did not actually start the socketModeClient, which
meant the process would immediately terminate.
@gitwave gitwave bot added the untriaged label Mar 24, 2021
@CLAassistant
Copy link

CLAassistant commented Mar 24, 2021

CLA assistant check
All committers have signed the CLA.

@seratch seratch added bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented docs M-T: Documentation work only pkg:socket-mode applies to `@slack/socket-mode` and removed untriaged labels Mar 24, 2021
@seratch seratch self-requested a review March 24, 2021 02:29
@seratch
Copy link
Member

seratch commented Mar 24, 2021

@slifty Thanks for taking the time to make this pull request! When I updated the website #1176 , I should have fixed the README as well 🤦

@seratch seratch merged commit 6fdb30e into slackapi:main Mar 24, 2021
@seratch seratch changed the title Update documentation Correct Socket Mode package README Mar 24, 2021
@seratch seratch added this to the socket-mode@1.1 milestone Mar 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented docs M-T: Documentation work only pkg:socket-mode applies to `@slack/socket-mode`
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants