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

Docs: Fix example code for team_join event #886

Merged
merged 1 commit into from
Apr 15, 2021

Conversation

preshetin
Copy link
Contributor

Thanks for this lib! When using example from the documentation I ran into a bug. It appeared the bug leaked into the chunk of code.

Summary

This PR improves documentation. The team_join event looks like { user: {id: 'U1234567', ...}, ... } and not like { user: 'U1234567', ... }.

Since this is a trivial change, I figured not to clone the repo and just fork it and create PR directly from the browser. I hope this is fine in such a trivial case.

Requirements

The event property looks like `{ user: {id: 'U1234567'} }` and not like `{ user: 'U1234567' }`
@gitwave gitwave bot added the untriaged label Apr 15, 2021
@CLAassistant
Copy link

CLAassistant commented Apr 15, 2021

CLA assistant check
All committers have signed the CLA.

@codecov
Copy link

codecov bot commented Apr 15, 2021

Codecov Report

Merging #886 (5302288) into main (42e731e) will not change coverage.
The diff coverage is n/a.

❗ Current head 5302288 differs from pull request most recent head 5a14a06. Consider uploading reports for the commit 5a14a06 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main     #886   +/-   ##
=======================================
  Coverage   66.11%   66.11%           
=======================================
  Files          13       13           
  Lines        1201     1201           
  Branches      354      354           
=======================================
  Hits          794      794           
  Misses        338      338           
  Partials       69       69           

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 42e731e...5a14a06. Read the comment docs.

@preshetin preshetin changed the title docs: fix bug in the docs Docs: Fix example code for team_join event Apr 15, 2021
@mwbrooks mwbrooks self-assigned this Apr 15, 2021
@mwbrooks mwbrooks added docs M-T: Documentation work only and removed untriaged labels Apr 15, 2021
@mwbrooks
Copy link
Member

Hey @preshetin 👋🏻 Thanks for the compliments about Bolt 🙇🏻

And a big thanks for catching this documentation typo! We thought we fixed all of these, so it's great that you caught this one. A pull request from the browser is totally fine and thanks for signing the CA!

@mwbrooks mwbrooks merged commit b80422a into slackapi:main Apr 15, 2021
@mwbrooks
Copy link
Member

🚀 Your update is live: https://slack.dev/bolt-js/concepts#event-listening

Feel free to delete your branch whenever you like. Thanks again for the contribution!

@shaydewael shaydewael mentioned this pull request Apr 15, 2021
2 tasks
@preshetin preshetin deleted the patch-1 branch April 16, 2021 08:07
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.

None yet

3 participants