Skip to content

Conversation

@d-mahi14
Copy link

@d-mahi14 d-mahi14 commented Jan 30, 2026

Fixes #9995

Summary

This PR replaces placeholder TODOs in tools/snippets with meaningful documentation and adds simple tests for the exported snippet function.

Changes

  • lib/main.js: Implemented a minimal placeholder snippet function and updated JSDoc.
  • lib/index.js: Updated module-level documentation and exports.
  • test/test.js: Added basic tests verifying that the snippet function exists and returns input values unchanged.

Motivation

Improves the onboarding experience for new contributors by:

  • Replacing TODOs with clear JSDoc
  • Demonstrating how functions are documented and tested
  • Providing minimal, functional tests

Testing

  • Ran node test/test.js locally successfully
  • Verified that the snippet function behaves as expected
  • No changes to other modules
Screenshot 2026-01-31 000521

@stdlib-bot
Copy link
Contributor

Hello! Thank you for your contribution to stdlib.

We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:

  1. Please read our contributing guidelines.

  2. Update your pull request description to include this checked box:

    - [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

  • The developer's certificate of origin
  • Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

@stdlib-bot stdlib-bot added First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Needs Review A pull request which needs code review. labels Jan 30, 2026
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@d-mahi14 Thank you for opening this PR; however, we won't be accepting the proposed changes. The entire point of the snippets is that they should be copied and the TODOs indicate what devs copying the snippets should do in order to ensure the snippet is tailored to the respective package. Meaning, the presence of TODO is intentional and not something we want to change.

Thanks again for your interest, and we look forward to your future contributions.

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Jan 30, 2026
@kgryte kgryte closed this Jan 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First-time Contributor A pull request from a contributor who has never previously committed to the project repository.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

tools/snippets: add documentation and basic tests for placeholder snippet function

3 participants