tools/snippets: add documentation and basic tests for placeholder sni…#9996
tools/snippets: add documentation and basic tests for placeholder sni…#9996d-mahi14 wants to merge 1 commit intostdlib-js:developfrom
Conversation
|
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:
This acknowledgment confirms that you've read the guidelines, which include:
We can't review or accept contributions without this acknowledgment. Thank you for your understanding and cooperation. We look forward to reviewing your contribution! |
kgryte
left a comment
There was a problem hiding this comment.
@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.
Fixes #9995
Summary
This PR replaces placeholder TODOs in
tools/snippetswith 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:
Testing
node test/test.jslocally successfully