Skip to content

Commit deef1c9

Browse files
committed
chore: Improve docstrings.
1 parent 8a5a585 commit deef1c9

3 files changed

Lines changed: 3 additions & 2 deletions

File tree

core/comments/collapse_comment_bar_button.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const COMMENT_COLLAPSE_BAR_BUTTON_FOCUS_IDENTIFIER =
1818
'_collapse_bar_button';
1919

2020
/**
21-
* Icon that toggles the collapsed state of a comment.
21+
* Button that toggles the collapsed state of a comment.
2222
*/
2323
export class CollapseCommentBarButton extends CommentBarButton {
2424
/**

core/comments/comment_bar_button.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export abstract class CommentBarButton implements IFocusableNode {
5959
abstract performAction(e?: Event): void;
6060

6161
/**
62-
* Returns the dimensions of this button in SVG units.
62+
* Returns the dimensions of this button in workspace coordinates.
6363
*
6464
* @param includeMargin True to include the margin when calculating the size.
6565
* @returns The size of this button.

core/keyboard_nav/block_navigation_policy.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ function getBlockNavigationCandidates(
148148
* Returns the next/previous stack relative to the given element's stack.
149149
*
150150
* @param current The element whose stack will be navigated relative to.
151+
* @param workspace The workspace to navigate between stacks on.
151152
* @param delta The difference in index to navigate; positive values navigate
152153
* to the nth next stack, while negative values navigate to the nth previous
153154
* stack.

0 commit comments

Comments
 (0)