Skip to content
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.

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

Add advice about read-only lists #292

Merged
merged 3 commits into from
May 13, 2021
Merged
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions index.bs
Original file line number Diff line number Diff line change
@@ -989,6 +989,13 @@ converting {{undefined}} to the type of the parameter.
For example, if a boolean parameter isn't set,
it must default to false.

When deciding between different list data types for your API,
unless otherwise required, use the following list types:

* Method list arguments should be of type [=sequence types|sequence&ltT&gt=]
* Method return values should be of type [=sequence types|sequence&ltT&gt=]
* Attributes should be of type [=observable array type|ObservableArray&ltT&gt=]

See also:

* [[#prefer-dict-to-bool]]