Skip to content

Commit 19eae5a

Browse files
committed
pr feedback
1 parent e6e44a2 commit 19eae5a

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

docs/content/guides/app-distribution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Bolt for Java automatically includes support for [org-wide installations](https:
1919

2020
### What your Bolt app does
2121

22-
To properly handle the OAuth Flow:
22+
To properly handle the OAuth flow:
2323

24-
* Provide an endpoint starting the OAuth flow by redirecting installers to Slack's `authorize` endpoint with sufficient parameters
24+
* Provide an endpoint starting the OAuth flow by redirecting installers to the `authorize` endpoint with sufficient parameters
2525
* Generate a `state` parameter value to verify afterwards
2626
* Append `client_id`, `scope`, `user_scope` (only for v2), and `state` to the URL
2727
* Provide an endpoint to handle user redirection from Slack

docs/content/guides/audit-logs-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Refer to the [Javadoc](https://oss.sonatype.org/service/local/repositories/relea
7878

7979
The Audit Logs API methods conform to Slack's [rate limits](https://docs.slack.dev/apis/web-api/rate-limits) and all methods are rated Tier 3. This allows for up to 50 calls per minute, with an allowance for sporadic bursts. Refer to [the API documentation](https://docs.slack.dev/admins/audit-logs-api) for more details.
8080

81-
The async client, `AsyncAuditClient`, has great consideration for rate limits. The async client internally has its queue systems to avoid burst traffics as much as possible while `AuditClient`, the synchronous client, always blindly sends requests. Both sync and async clients maintain the metrics data in a `MetricsDatastore` together. This allows the async client to accurately know the current traffic they generated toward the Slack platform and estimate the remaining amount to call.
81+
The async client, `AsyncAuditClient`, takes rate limits into consideration. The async client internally has its queue systems to avoid burst traffics as much as possible while `AuditClient`, the synchronous client, always blindly sends requests. Both sync and async clients maintain the metrics data in a `MetricsDatastore` together. This allows the async client to accurately know the current traffic they generated toward the Slack platform and estimate the remaining amount to call.
8282

8383
The default implementation of the datastore is an in-memory one using the JVM heap memory. The default `SlackConfig` enables the in-memory one.
8484

docs/content/guides/bolt-basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ app.command("/hello", (req, ctx) -> {
154154
---
155155
## Use Web APIs / reply using `say` utility
156156

157-
Use `ctx.client()` to call Slack Web API methods in Bolt apps. The `MethodsClient` created by the method already holds a valid bot token, so there is no need to provide a token to it. Simply call the method with parameters as below.
157+
Use `ctx.client()` to call Slack Web API methods in Bolt apps. The `MethodsClient` created by the method already holds a valid bot token, so there is no need to provide a token to it. Call the method with parameters as below.
158158

159159
```java
160160
app.command("/hello", (req, ctx) -> {

docs/content/guides/composing-messages.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ ChatPostMessageResponse response = slack.methods(token).chatPostMessage(req -> r
2929
);
3030
```
3131

32-
As you see, using `text` is fairly simple: give a string value with a valid format. Consult [Basic formatting with `mrkdwn`](https://docs.slack.dev/messaging/formatting-message-text) for understanding the markup language.
32+
Use `text` by providing a string value with a valid format. Consult [Basic formatting with `mrkdwn`](https://docs.slack.dev/messaging/formatting-message-text) for understanding the markup language.
3333

3434
---
3535
## Building blocks for rich message layouts
@@ -67,7 +67,7 @@ ChatPostMessageResponse response = slack.methods(token).chatPostMessage(req -> r
6767
);
6868
```
6969

70-
You build a message for incoming webhooks and `response_url` calls this way too.
70+
You can build a message for incoming webhooks and `response_url` calls this way too.
7171

7272
---
7373
## Block Kit Kotlin DSL

docs/content/guides/events-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ app.message(":wave:", (payload, ctx) -> {
141141

142142
## Under the hood
143143

144-
If you hope to understand what is happening with the above code, reading the following (a bit pseudo) code may be helpful.
144+
If you hope to understand what is happening with the above code, reading the following (pseudo) code may be helpful.
145145

146146
```java
147147
import java.util.Map;

docs/content/guides/getting-started-with-bolt.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ run {
231231
<Tabs groupId="socket-or-http">
232232
<TabItem value="socket-mode" label="Socket Mode">
233233

234-
Only single source code is required to run your first Bolt app. All you need to do is define the main method that starts `SocketModeApp`.
234+
Only single source code is required to run your first Bolt app. You'll need to define the main method that starts `SocketModeApp`.
235235

236236
```java
237237
package hello;
@@ -254,7 +254,7 @@ public class MyApp {
254254
}
255255
```
256256

257-
If you go with JDK 10+, thanks to [Local Variable Type Inference](https://docs.oracle.com/en/java/javase/21/language/local-variable-type-inference.html), your code could be much more concise. To take advantage of it, install OpenJDK 11 and set the compatible Java versions in `build.gradle` as below. Also, configure the same on your IDE.
257+
If you go with JDK 10+, thanks to [Local Variable Type Inference](https://docs.oracle.com/en/java/javase/21/language/local-variable-type-inference.html), you can write more concise code. To do so, install OpenJDK 11 and set the compatible Java versions in `build.gradle` as below, configuring the same on your IDE.
258258

259259
```groovy
260260
java {
@@ -276,7 +276,7 @@ new SocketModeApp(app).start();
276276
</TabItem>
277277
<TabItem value="http" label="HTTP">
278278

279-
Only single source code is required to run your first Bolt app. All you need to do is define the main method that starts `SlackAppServer`. Your server with the default configuration will listen to the 3000 port but it's configurable. Check other constructors of the class to customize the behavior.
279+
Only single source code is required to run your first Bolt app. You'll need to define the main method that starts `SlackAppServer`. Your server with the default configuration will listen to the 3000 port but it's configurable. Check other constructors of the class to customize the behavior.
280280

281281
```java
282282
package hello;
@@ -300,7 +300,7 @@ public class MyApp {
300300
}
301301
```
302302

303-
If you go with JDK 10+, thanks to [Local Variable Type Inference](https://docs.oracle.com/en/java/javase/21/language/local-variable-type-inference.html), your code could be much more concise. To take advantage of it, install OpenJDK 11 and set the compatible Java versions in `build.gradle` as below. Also, configure the same on your IDE.
303+
If you go with JDK 10+, thanks to [Local Variable Type Inference](https://docs.oracle.com/en/java/javase/21/language/local-variable-type-inference.html), you can write more concise code. To do so, install OpenJDK 11 and set the compatible Java versions in `build.gradle` as below, configuring the same on your IDE.
304304

305305
```groovy
306306
java {
@@ -423,7 +423,7 @@ Now you can hit the `/hello` command in your development workspace. If your app
423423

424424
As [Spring Boot](https://spring.io/projects/spring-boot) is one of the most popular web frameworks in the Java world, you may be curious about the possibility to let this Bolt app live together with it.
425425

426-
Rest assured, we can _inject_ Bolt into Spring Boot apps.
426+
Don't worry, we can _inject_ Bolt into Spring Boot apps.
427427

428428
Add `implementation("com.slack.api:bolt:sdkLatestVersion")` to `dependencies` in `build.gradle` and write a few lines of code.
429429

docs/content/guides/incoming-webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ lang: en
44

55
# Incoming webhooks
66

7-
[Incoming webhooks](https://docs.slack.dev/messaging/sending-messages-using-incoming-webhooks) are a simple way to post messages from apps into Slack. Creating an incoming webhook gives you a unique URL to which you send a JSON payload with the message and some options.
7+
[Incoming webhooks](https://docs.slack.dev/messaging/sending-messages-using-incoming-webhooks) are a straightforward way to post messages from apps into Slack. Creating an incoming webhook gives you a unique URL to which you send a JSON payload with the message and some options.
88

99
### Slack app configuration
1010

0 commit comments

Comments
 (0)