Add docs for widget container height option #27922
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
t3chguy
reviewed
Aug 16, 2024
|
|
||
| - `default_widget_container_height` | ||
|
|
||
| This controls the height that the top widget panel initially appears as and is the height in pixels, default 280. |
There was a problem hiding this comment.
This doesn't match the value in the config sample, is the default 280 or 280px?
t3chguy
approved these changes
Aug 16, 2024
| @@ -22,6 +22,7 @@ | |||
| "https://scalar-staging.vector.im/api", | |||
| "https://scalar-staging.riot.im/scalar/api" | |||
| ], | |||
| "default_widget_height": 280, | |||
There was a problem hiding this comment.
This key seems to have the wrong name, since the documentation and implementation both use default_widget_container_height instead.
There was a problem hiding this comment.
oh, good spot, although the correct way to report these is by filing bugs. In general, people won't be looking at old, closed PRs unless they happen to see it in notifications.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See matrix-org/matrix-react-sdk#12893
Checklist
public/exportedsymbols have accurate TSDoc documentation.