Skip to content

Commit 642c8e7

Browse files
mwbrookszimeg
andauthored
docs: add comment block to package slackcontext (#62)
* docs: add comment block to package slackcontext * Update internal/slackcontext/slackcontext.go Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com> * docs: tweak wording from request-scope to execution-scope --------- Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>
1 parent c8050cf commit 642c8e7

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

internal/slackcontext/slackcontext.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
// Package slackcontext defines getters and setters for execution-scoped values
16+
// that are propagated through context.Context during the execution of a Slack
17+
// command. These values may include unique identifiers, session metadata, host
18+
// information, version details, and other execution data.
19+
//
20+
// All values should be set in the context before a Slack command begins execution.
21+
// The values can then be accessed throughout the command's execution lifecycle
22+
// using the provided getter methods.
23+
//
24+
// Each value is stored with an unexported key type to prevent collisions with
25+
// other packages using context values. The package provides type-safe accessors
26+
// for retrieving these values.
1527
package slackcontext
1628

1729
import (

0 commit comments

Comments
 (0)