Skip to content

Commit 4bbbc3d

Browse files
zimegClaude
andcommitted
docs(methods): trim codeChannels example comments to match convention
Match the chat.postMessage example's minimal "Call the <method> method" comment style; drop the trailing explanatory clauses. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
1 parent b2cc290 commit 4bbbc3d

10 files changed

Lines changed: 10 additions & 18 deletions

‎methods/src/code_channels/code_channels_archive.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
# Initialize
99
client = WebClient(token=token)
1010

11-
# Call the codeChannels.archive method to close out a code channel, optionally
12-
# recording the message that summarizes the work
11+
# Call the codeChannels.archive method
1312
response = client.codeChannels_archive(
1413
channel_id="C123ABC456",
1514
summary_message_ts="1717171717.123456",

‎methods/src/code_channels/code_channels_create.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
# Initialize
99
client = WebClient(token=token)
1010

11-
# Call the codeChannels.create method to spin up a code channel for a session,
12-
# rooted at the message that asked for it
11+
# Call the codeChannels.create method
1312
response = client.codeChannels_create(
1413
name="Fix flaky login test",
1514
origin_channel_id="C123ABC456",

‎methods/src/code_channels/code_channels_get_canvas.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
# Initialize
99
client = WebClient(token=token)
1010

11-
# Call the codeChannels.getCanvas method to read a code channel canvas's content
12-
# along with its comment threads
11+
# Call the codeChannels.getCanvas method
1312
response = client.codeChannels_getCanvas(
1413
channel_id="C123ABC456",
1514
)

‎methods/src/code_channels/code_channels_list_views.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
# Initialize
99
client = WebClient(token=token)
1010

11-
# Call the codeChannels.listViews method to read the view tabs currently
12-
# attached to a code channel
11+
# Call the codeChannels.listViews method
1312
response = client.codeChannels_listViews(
1413
channel_id="C123ABC456",
1514
)

‎methods/src/code_channels/code_channels_remove_view.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
# Initialize
99
client = WebClient(token=token)
1010

11-
# Call the codeChannels.removeView method to detach a view tab from a code
12-
# channel by its view ID
11+
# Call the codeChannels.removeView method
1312
response = client.codeChannels_removeView(
1413
channel_id="C123ABC456",
1514
view_id="V123ABC456",

‎methods/src/code_channels/code_channels_rename.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# Initialize
99
client = WebClient(token=token)
1010

11-
# Call the codeChannels.rename method to give a code channel a new name
11+
# Call the codeChannels.rename method
1212
response = client.codeChannels_rename(
1313
channel_id="C123ABC456",
1414
name="Fix flaky login test v2",

‎methods/src/code_channels/code_channels_set_canvas_content.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
# Initialize
99
client = WebClient(token=token)
1010

11-
# Call the codeChannels.setCanvasContent method to replace a code channel
12-
# canvas's content while preserving its comment anchors
11+
# Call the codeChannels.setCanvasContent method
1312
response = client.codeChannels_setCanvasContent(
1413
channel_id="C123ABC456",
1514
content="# Plan\n\n1. Reproduce the flaky test\n2. Fix the race\n3. Verify",

‎methods/src/code_channels/code_channels_set_commands.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
# Initialize
99
client = WebClient(token=token)
1010

11-
# Call the codeChannels.setCommands method to register the per-channel slash
12-
# commands the agent offers inside a code channel
11+
# Call the codeChannels.setCommands method
1312
response = client.codeChannels_setCommands(
1413
channel_id="C123ABC456",
1514
commands=[

‎methods/src/code_channels/code_channels_set_properties.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
# Initialize
99
client = WebClient(token=token)
1010

11-
# Call the codeChannels.setProperties method to pin context bar items (up to
12-
# five) and external resource details to a code channel
11+
# Call the codeChannels.setProperties method
1312
response = client.codeChannels_setProperties(
1413
channel_id="C123ABC456",
1514
code_channel={

‎methods/src/code_channels/code_channels_set_view.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# Initialize
99
client = WebClient(token=token)
1010

11-
# Call the codeChannels.setView method to publish a diff to the channel's code tab
11+
# Call the codeChannels.setView method
1212
response = client.codeChannels_setView(
1313
channel_id="C123ABC456",
1414
type="diff",

0 commit comments

Comments
 (0)