Skip to content

docs: align BrightScript SDK documentation #992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathannorris merged 2 commits into from
Aug 7, 2026
Merged

docs: align BrightScript SDK documentation #992

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b97904
docs: align BrightScript SDK documentation
jonathannorris Aug 6, 2026
2790fd5
docs: clarify Roku initialization terminology
jonathannorris Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/sdk/client-side-sdks/roku/roku-gettingstarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ The DevCycleUser can be built using the following methods [DevCycleUser](https:/

The SDK exposes various initialization options which can be used by passing a `DevCycleOptions` object to the `options` parameter of `InitializeDevCycleClient` method:

[DevCycle Options](https://github.com/DevCycleHQ-Labs/roku-client-sdk/blob/main/components/DevCycle/DevCycleOptions.brs)
[DevCycle Options](https://github.com/DevCycleHQ/roku-client-sdk/blob/main/components/DevCycle/DevCycleOptions.brs)

| Method | Parameter | Default | Description |
| ---------------------------- | --------- | ------- | -------------------------------------------------------------------------------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/client-side-sdks/roku/roku-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To get all the Features returned in the config:
features = m.devcycleClient.getAllFeatures()
```

If the SDK has not finished initializing, these methods will return an empty object.
If the SDK has not finished initializing, these methods log an error and return `invalid`. Wait until the `DevCycleTask` node has initialized before calling them.

### Get All Variables

Expand All @@ -45,7 +45,7 @@ To get all the variables returned in the config:
variables = m.devcycleClient.getAllVariables()
```

If the SDK has not finished initializing, these methods will return an empty object.
If the SDK has not finished initializing, these methods log an error and return `invalid`. Wait until the `DevCycleTask` node has initialized before calling them.

:::caution

Expand Down
Loading