Skip to content

Clarify permissions documentation #223

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
RonvanderPlas merged 2 commits into from
Dec 8, 2025
Merged

Clarify permissions documentation #223

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e860a4
Clarify permissions documentation
RonvanderPlas Dec 8, 2025
c97bc49
Formatting
RonvanderPlas Dec 8, 2025
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
3 changes: 2 additions & 1 deletion docs/v2/batteries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ Mode `standby` is exactly the same as mode `zero` with both charging and dischar

- When switching to `standby` mode, the `permissions` field will be set to an empty array `[]`.
- When adding a permission to the `permissions` field while in `standby` mode, the mode will automatically switch to `zero`.
- `zero` mode with both permissions allowed is the same as the default `zero` mode.
- `zero` mode with both permissions **allowed** is the same as the default `zero` mode.
- `zero` mode with both permissions **disallowed** is the same as `standby` mode, therefore mode will automatically switch to `standby`.

## Examples

Expand Down