Skip to content

Commit 273ae4c

Browse files
zimegClaude
andcommitted
docs(web-api): align codeChannels.* docstrings with the API reference summaries
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
1 parent fa062a6 commit 273ae4c

3 files changed

Lines changed: 36 additions & 30 deletions

File tree

‎slack_sdk/web/async_client.py‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2120,7 +2120,7 @@ async def codeChannels_archive(
21202120
summary_message_ts: Optional[str] = None,
21212121
**kwargs,
21222122
) -> AsyncSlackResponse:
2123-
"""Archive a code channel, optionally recording a summary.
2123+
"""Archives a code channel, optionally recording a summary message on the channel.
21242124
https://docs.slack.dev/reference/methods/codeChannels.archive
21252125
"""
21262126
kwargs.update({"channel_id": channel_id, "summary_message_ts": summary_message_ts})
@@ -2138,7 +2138,7 @@ async def codeChannels_create(
21382138
origin_message_ts: Optional[str] = None,
21392139
**kwargs,
21402140
) -> AsyncSlackResponse:
2141-
"""Create a code channel for a session.
2141+
"""Creates a dedicated code channel for an agent session.
21422142
https://docs.slack.dev/reference/methods/codeChannels.create
21432143
"""
21442144
kwargs.update(
@@ -2163,7 +2163,7 @@ async def codeChannels_getCanvas(
21632163
include_resolved: Optional[bool] = None,
21642164
**kwargs,
21652165
) -> AsyncSlackResponse:
2166-
"""Read a code channel canvas's content and its comment threads.
2166+
"""Fetches a canvas attached to a code channel — full content plus comment threads — in a single round-trip.
21672167
https://docs.slack.dev/reference/methods/codeChannels.getCanvas
21682168
"""
21692169
kwargs.update(
@@ -2183,7 +2183,7 @@ async def codeChannels_listViews(
21832183
channel_id: str,
21842184
**kwargs,
21852185
) -> AsyncSlackResponse:
2186-
"""List the view tabs attached to a code channel.
2186+
"""Lists the views currently attached to a code channel.
21872187
https://docs.slack.dev/reference/methods/codeChannels.listViews
21882188
"""
21892189
kwargs.update({"channel_id": channel_id})
@@ -2198,7 +2198,7 @@ async def codeChannels_removeView(
21982198
view_id: Optional[str] = None,
21992199
**kwargs,
22002200
) -> AsyncSlackResponse:
2201-
"""Remove a view tab from a code channel (provide exactly one of view_key or view_id).
2201+
"""Removes a view from a code channel (provide exactly one of view_key or view_id).
22022202
https://docs.slack.dev/reference/methods/codeChannels.removeView
22032203
"""
22042204
kwargs.update({"channel_id": channel_id, "view_key": view_key, "view_id": view_id})
@@ -2212,7 +2212,7 @@ async def codeChannels_rename(
22122212
name: str,
22132213
**kwargs,
22142214
) -> AsyncSlackResponse:
2215-
"""Rename a code channel.
2215+
"""Renames a code channel.
22162216
https://docs.slack.dev/reference/methods/codeChannels.rename
22172217
"""
22182218
kwargs.update({"channel_id": channel_id, "name": name})
@@ -2227,7 +2227,8 @@ async def codeChannels_setCanvasContent(
22272227
content: str,
22282228
**kwargs,
22292229
) -> AsyncSlackResponse:
2230-
"""Replace a code channel canvas's content while preserving comment anchors.
2230+
"""Replaces the full markdown content of a canvas attached to a code channel, preserving the
2231+
comment threads on the sections your agent didn't change.
22312232
https://docs.slack.dev/reference/methods/codeChannels.setCanvasContent
22322233
"""
22332234
kwargs.update({"channel_id": channel_id, "canvas_id": canvas_id, "content": content})
@@ -2241,7 +2242,7 @@ async def codeChannels_setCommands(
22412242
commands: List[Dict[str, Any]],
22422243
**kwargs,
22432244
) -> AsyncSlackResponse:
2244-
"""Register the agent's per-channel slash commands for a code channel.
2245+
"""Registers the set of slash commands your agent offers in a code channel.
22452246
https://docs.slack.dev/reference/methods/codeChannels.setCommands
22462247
"""
22472248
kwargs.update({"channel_id": channel_id, "commands": commands})
@@ -2256,7 +2257,7 @@ async def codeChannels_setProperties(
22562257
agent_resource: Optional[Dict[str, Any]] = None,
22572258
**kwargs,
22582259
) -> AsyncSlackResponse:
2259-
"""Set a code channel's context bar items and external resource details.
2260+
"""Sets properties on a code channel: context bar items and external resource details.
22602261
https://docs.slack.dev/reference/methods/codeChannels.setProperties
22612262
"""
22622263
kwargs.update(
@@ -2286,7 +2287,8 @@ async def codeChannels_setView(
22862287
csp: Optional[Dict[str, Any]] = None,
22872288
**kwargs,
22882289
) -> AsyncSlackResponse:
2289-
"""Create or update a view tab (html, diff, block_kit, or canvas) on a code channel.
2290+
"""Creates or updates a view in a code channel. Views can render HTML, diffs, Block Kit, or
2291+
canvases as tabs alongside the conversation.
22902292
https://docs.slack.dev/reference/methods/codeChannels.setView
22912293
"""
22922294
kwargs.update(

‎slack_sdk/web/client.py‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2110,7 +2110,7 @@ def codeChannels_archive(
21102110
summary_message_ts: Optional[str] = None,
21112111
**kwargs,
21122112
) -> SlackResponse:
2113-
"""Archive a code channel, optionally recording a summary.
2113+
"""Archives a code channel, optionally recording a summary message on the channel.
21142114
https://docs.slack.dev/reference/methods/codeChannels.archive
21152115
"""
21162116
kwargs.update({"channel_id": channel_id, "summary_message_ts": summary_message_ts})
@@ -2128,7 +2128,7 @@ def codeChannels_create(
21282128
origin_message_ts: Optional[str] = None,
21292129
**kwargs,
21302130
) -> SlackResponse:
2131-
"""Create a code channel for a session.
2131+
"""Creates a dedicated code channel for an agent session.
21322132
https://docs.slack.dev/reference/methods/codeChannels.create
21332133
"""
21342134
kwargs.update(
@@ -2153,7 +2153,7 @@ def codeChannels_getCanvas(
21532153
include_resolved: Optional[bool] = None,
21542154
**kwargs,
21552155
) -> SlackResponse:
2156-
"""Read a code channel canvas's content and its comment threads.
2156+
"""Fetches a canvas attached to a code channel — full content plus comment threads — in a single round-trip.
21572157
https://docs.slack.dev/reference/methods/codeChannels.getCanvas
21582158
"""
21592159
kwargs.update(
@@ -2173,7 +2173,7 @@ def codeChannels_listViews(
21732173
channel_id: str,
21742174
**kwargs,
21752175
) -> SlackResponse:
2176-
"""List the view tabs attached to a code channel.
2176+
"""Lists the views currently attached to a code channel.
21772177
https://docs.slack.dev/reference/methods/codeChannels.listViews
21782178
"""
21792179
kwargs.update({"channel_id": channel_id})
@@ -2188,7 +2188,7 @@ def codeChannels_removeView(
21882188
view_id: Optional[str] = None,
21892189
**kwargs,
21902190
) -> SlackResponse:
2191-
"""Remove a view tab from a code channel (provide exactly one of view_key or view_id).
2191+
"""Removes a view from a code channel (provide exactly one of view_key or view_id).
21922192
https://docs.slack.dev/reference/methods/codeChannels.removeView
21932193
"""
21942194
kwargs.update({"channel_id": channel_id, "view_key": view_key, "view_id": view_id})
@@ -2202,7 +2202,7 @@ def codeChannels_rename(
22022202
name: str,
22032203
**kwargs,
22042204
) -> SlackResponse:
2205-
"""Rename a code channel.
2205+
"""Renames a code channel.
22062206
https://docs.slack.dev/reference/methods/codeChannels.rename
22072207
"""
22082208
kwargs.update({"channel_id": channel_id, "name": name})
@@ -2217,7 +2217,8 @@ def codeChannels_setCanvasContent(
22172217
content: str,
22182218
**kwargs,
22192219
) -> SlackResponse:
2220-
"""Replace a code channel canvas's content while preserving comment anchors.
2220+
"""Replaces the full markdown content of a canvas attached to a code channel, preserving the
2221+
comment threads on the sections your agent didn't change.
22212222
https://docs.slack.dev/reference/methods/codeChannels.setCanvasContent
22222223
"""
22232224
kwargs.update({"channel_id": channel_id, "canvas_id": canvas_id, "content": content})
@@ -2231,7 +2232,7 @@ def codeChannels_setCommands(
22312232
commands: List[Dict[str, Any]],
22322233
**kwargs,
22332234
) -> SlackResponse:
2234-
"""Register the agent's per-channel slash commands for a code channel.
2235+
"""Registers the set of slash commands your agent offers in a code channel.
22352236
https://docs.slack.dev/reference/methods/codeChannels.setCommands
22362237
"""
22372238
kwargs.update({"channel_id": channel_id, "commands": commands})
@@ -2246,7 +2247,7 @@ def codeChannels_setProperties(
22462247
agent_resource: Optional[Dict[str, Any]] = None,
22472248
**kwargs,
22482249
) -> SlackResponse:
2249-
"""Set a code channel's context bar items and external resource details.
2250+
"""Sets properties on a code channel: context bar items and external resource details.
22502251
https://docs.slack.dev/reference/methods/codeChannels.setProperties
22512252
"""
22522253
kwargs.update(
@@ -2276,7 +2277,8 @@ def codeChannels_setView(
22762277
csp: Optional[Dict[str, Any]] = None,
22772278
**kwargs,
22782279
) -> SlackResponse:
2279-
"""Create or update a view tab (html, diff, block_kit, or canvas) on a code channel.
2280+
"""Creates or updates a view in a code channel. Views can render HTML, diffs, Block Kit, or
2281+
canvases as tabs alongside the conversation.
22802282
https://docs.slack.dev/reference/methods/codeChannels.setView
22812283
"""
22822284
kwargs.update(

‎slack_sdk/web/legacy_client.py‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2121,7 +2121,7 @@ def codeChannels_archive(
21212121
summary_message_ts: Optional[str] = None,
21222122
**kwargs,
21232123
) -> Union[Future, SlackResponse]:
2124-
"""Archive a code channel, optionally recording a summary.
2124+
"""Archives a code channel, optionally recording a summary message on the channel.
21252125
https://docs.slack.dev/reference/methods/codeChannels.archive
21262126
"""
21272127
kwargs.update({"channel_id": channel_id, "summary_message_ts": summary_message_ts})
@@ -2139,7 +2139,7 @@ def codeChannels_create(
21392139
origin_message_ts: Optional[str] = None,
21402140
**kwargs,
21412141
) -> Union[Future, SlackResponse]:
2142-
"""Create a code channel for a session.
2142+
"""Creates a dedicated code channel for an agent session.
21432143
https://docs.slack.dev/reference/methods/codeChannels.create
21442144
"""
21452145
kwargs.update(
@@ -2164,7 +2164,7 @@ def codeChannels_getCanvas(
21642164
include_resolved: Optional[bool] = None,
21652165
**kwargs,
21662166
) -> Union[Future, SlackResponse]:
2167-
"""Read a code channel canvas's content and its comment threads.
2167+
"""Fetches a canvas attached to a code channel — full content plus comment threads — in a single round-trip.
21682168
https://docs.slack.dev/reference/methods/codeChannels.getCanvas
21692169
"""
21702170
kwargs.update(
@@ -2184,7 +2184,7 @@ def codeChannels_listViews(
21842184
channel_id: str,
21852185
**kwargs,
21862186
) -> Union[Future, SlackResponse]:
2187-
"""List the view tabs attached to a code channel.
2187+
"""Lists the views currently attached to a code channel.
21882188
https://docs.slack.dev/reference/methods/codeChannels.listViews
21892189
"""
21902190
kwargs.update({"channel_id": channel_id})
@@ -2199,7 +2199,7 @@ def codeChannels_removeView(
21992199
view_id: Optional[str] = None,
22002200
**kwargs,
22012201
) -> Union[Future, SlackResponse]:
2202-
"""Remove a view tab from a code channel (provide exactly one of view_key or view_id).
2202+
"""Removes a view from a code channel (provide exactly one of view_key or view_id).
22032203
https://docs.slack.dev/reference/methods/codeChannels.removeView
22042204
"""
22052205
kwargs.update({"channel_id": channel_id, "view_key": view_key, "view_id": view_id})
@@ -2213,7 +2213,7 @@ def codeChannels_rename(
22132213
name: str,
22142214
**kwargs,
22152215
) -> Union[Future, SlackResponse]:
2216-
"""Rename a code channel.
2216+
"""Renames a code channel.
22172217
https://docs.slack.dev/reference/methods/codeChannels.rename
22182218
"""
22192219
kwargs.update({"channel_id": channel_id, "name": name})
@@ -2228,7 +2228,8 @@ def codeChannels_setCanvasContent(
22282228
content: str,
22292229
**kwargs,
22302230
) -> Union[Future, SlackResponse]:
2231-
"""Replace a code channel canvas's content while preserving comment anchors.
2231+
"""Replaces the full markdown content of a canvas attached to a code channel, preserving the
2232+
comment threads on the sections your agent didn't change.
22322233
https://docs.slack.dev/reference/methods/codeChannels.setCanvasContent
22332234
"""
22342235
kwargs.update({"channel_id": channel_id, "canvas_id": canvas_id, "content": content})
@@ -2242,7 +2243,7 @@ def codeChannels_setCommands(
22422243
commands: List[Dict[str, Any]],
22432244
**kwargs,
22442245
) -> Union[Future, SlackResponse]:
2245-
"""Register the agent's per-channel slash commands for a code channel.
2246+
"""Registers the set of slash commands your agent offers in a code channel.
22462247
https://docs.slack.dev/reference/methods/codeChannels.setCommands
22472248
"""
22482249
kwargs.update({"channel_id": channel_id, "commands": commands})
@@ -2257,7 +2258,7 @@ def codeChannels_setProperties(
22572258
agent_resource: Optional[Dict[str, Any]] = None,
22582259
**kwargs,
22592260
) -> Union[Future, SlackResponse]:
2260-
"""Set a code channel's context bar items and external resource details.
2261+
"""Sets properties on a code channel: context bar items and external resource details.
22612262
https://docs.slack.dev/reference/methods/codeChannels.setProperties
22622263
"""
22632264
kwargs.update(
@@ -2287,7 +2288,8 @@ def codeChannels_setView(
22872288
csp: Optional[Dict[str, Any]] = None,
22882289
**kwargs,
22892290
) -> Union[Future, SlackResponse]:
2290-
"""Create or update a view tab (html, diff, block_kit, or canvas) on a code channel.
2291+
"""Creates or updates a view in a code channel. Views can render HTML, diffs, Block Kit, or
2292+
canvases as tabs alongside the conversation.
22912293
https://docs.slack.dev/reference/methods/codeChannels.setView
22922294
"""
22932295
kwargs.update(

0 commit comments

Comments
 (0)