Skip to content

Add JSDoc type annotations to selectPing function#6372

Closed
Lang-Qiu wants to merge 1 commit into
shiptest-ss13:masterfrom
Lang-Qiu:auto-pr/type_annotations-1780781947
Closed

Add JSDoc type annotations to selectPing function#6372
Lang-Qiu wants to merge 1 commit into
shiptest-ss13:masterfrom
Lang-Qiu:auto-pr/type_annotations-1780781947

Conversation

@Lang-Qiu

@Lang-Qiu Lang-Qiu commented Jun 6, 2026

Copy link
Copy Markdown

Background

The public exported function selectPing in tgui/packages/tgui-panel/ping/selectors.js was missing type annotations. Adding JSDoc type annotations improves code readability, maintainability, and facilitates better integration with TypeScript or other type-checking tools without altering functionality.

Changes

  • Added JSDoc type annotation to the selectPing function, specifying the state parameter as object and the return type as any.

Verification

Since this change only adds comments and does not modify the function's logic or API, it should be safe. You can verify by:

  1. Running existing tests to ensure no regressions.
  2. Checking that the code still executes as expected in the application.
  3. Optionally, using a linter or TypeScript compiler (if configured) to confirm type annotations are correctly formatted.

@github-actions github-actions Bot added the TGUI label Jun 6, 2026
@FalloutFalcon

Copy link
Copy Markdown
Member

Generative AI or otherwise automated process. I dont really care.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants