matrix-org / matrix-org/matrix-spec

Widgets exacerbate the lowerCamelCase mixed with snake_case problem

Open
#689 0 comments 0 reactions 0 assignees View on GitHub
A-Widgets wart
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

```json
{
"action": "set_always_on_screen",
"api": "fromWidget",
"data": {
"value": true
},
"requestId": "generated-id-1234",
"widgetId": "20200827_WidgetExample"
}
```

`requestId` is lowerCamelCase whereas the `set_always_on_screen` action is snake_case.

Contributor guide

Open the contributing guide

Research direction

Start with the JSON example in issue #689 and the Matrix protocol specification sections defining widget actions and fields. Check how `set_always_on_screen`, `requestId`, and `widgetId` are specified, then determine the scope of the naming inconsistency and what documentation updates would be needed for a consistent convention.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.