Skip to content

Add missing TSDoc to CSV description helpers in transforms - #14

Open
Samrudh9 with Copilot wants to merge 2 commits into
mainfrom
copilot/update-code-documentation
Open

Samrudh9 with Copilot wants to merge 2 commits into
mainfrom
copilot/update-code-documentation

Conversation

Copilot AI commented Sep 24, 2026 •

Copy link
Copy Markdown

Recent updates left a few exported helper functions undocumented, which drifted from the repository’s function-level TSDoc standard. This PR adds targeted doc comments where behavior benefits from explicit parameter/return semantics.

  • Documentation coverage (targeted)

    • Added TSDoc to categoryDescription, publisherDescription, and gameDescription in db/transforms.ts.
    • Comments document intent, input meaning, and output contract for each helper.
  • Scope

    • Documentation-only change; no runtime logic, signatures, or data flow modified.
/**
 * Append the fixed crowdfunding call-to-action to a game's source description.
 *
 * @param rawDescription - Base description from the CSV row.
 * @returns The stored description including the crowdfunding blurb.
 */
export function gameDescription(rawDescription: string): string {
  return rawDescription + CROWDFUNDING_BLURB;
}

@coderabbitai

coderabbitai Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: b51fd0cd-f38b-4302-ba08-55195aa4cfdb

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI linked an issue Sep 24, 2026 that may be closed by this pull request
Co-authored-by: Samrudh9 <84171396+Samrudh9@users.noreply.github.com>
@Samrudh9
Samrudh9 marked this pull request as ready for review September 24, 2026 10:33
Copilot AI changed the title [WIP] Add TSDoc comments to functions and methods Add missing TSDoc to CSV description helpers in transforms Sep 24, 2026
Copilot AI requested a review from Samrudh9 September 24, 2026 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Code lacks documentation

2 participants