Modernize examples in documentation #702
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #702 +/- ##
=======================================
Coverage 91.97% 91.97%
=======================================
Files 7 7
Lines 486 486
Branches 91 91
=======================================
Hits 447 447
Misses 22 22
Partials 17 17Continue to review full report at Codecov.
|
aoberoi
changed the title
shaydewael
approved these changes
Feb 15, 2019
docs/_pages/getting_started.md
Outdated
| the scope(s) with the least amount of privilege for your app's needs. In this guide we will use the | ||
| Web API to post a message. The scope required for this is called `chat:write:user`. Use the dropdown or start typing its name to select and add the scope, then click "Save Changes". | ||
| Navigate to "OAuth & Permissions" and scroll down to the section for scopes. Slack describes the various permissions | ||
| your app could obtain from a user as **scopes**. There are a [ton of scopes](https://api.slack.com/scopes)! Some are |
There was a problem hiding this comment.
replace "tons of scopes" with "over 60 scopes"
docs/_pages/rtm_client.md
Outdated
| rtm.on(`message::channel_name`, (event) => { | ||
| // For structure of `event`, see https://api.slack.com/events/message/channel_name | ||
| console.log(`A channel was renamed from ${message.old_name} to ${message.name}`); | ||
| }); | ||
| ``` | ||
|
|
||
| If you rename a channel in which the bot is a member, you should see the log message. | ||
| With this program running, when you rename a channel in which the bot is a member, you should see the log message. |
There was a problem hiding this comment.
This sentence is confusing. Maybe "When the program is running and you rename a channel your bot is a member of, you should see the logged message."
examples/README.md
Outdated
| @@ -1,12 +1,13 @@ | |||
| ## Examples | |||
|
|
|||
| This directory contains small example programs that you can copy to get started quickly. Try these examples out for | |||
| yourself by cloning (or downloading) this repository, running `npm install` in this directory, and running one of the | |||
| scripts (e.g. `node basic-web-client.js`). We recommend using the latest LTS version node. | |||
| yourself by cloning (or downloading) this repository, running `npm install` in this directory. Then run one of the | |||
There was a problem hiding this comment.
"Try these examples out for yourself by cloning (or downloading) this repository and running npm install in this directory"
|
thanks for the thorough review. these comments are spot on! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The goal is to update all our examples to syntax that is modern. This also cleans up language used, particularly around workspace apps. Also took the opportunity to remove old tests that were no longer being used.
Requirements (place an
xin each[ ])