Skip to content

Conversation

@Ni-zav
Copy link
Contributor

@Ni-zav Ni-zav commented May 25, 2025

Description

added JSDoc comments and usage examples to all exported functions in prompt_templates.ts. This should improves the code readability, help contributors understand the codebase.

Type of Change

  • Documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have tested the app on Mac OS (If not, leave unchecked so we can test before merging)
  • I have tested the app on Windows (If not, leave unchecked so we can test before merging)

@gauravagerwala
Copy link
Collaborator

Thank you for the contribution.

@gauravagerwala gauravagerwala merged commit a4ea9b3 into platinum-hill:main May 25, 2025
2 checks passed
@Ni-zav Ni-zav deleted the docs/add-jsdoc branch May 28, 2025 11:44
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.

2 participants