Skip to content

docs: add JSDoc example and remove annotation #15523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Sep 25, 2026
Merged

docs: add JSDoc example and remove annotation #15523

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,30 @@
/**
* Infers license information from file content.
*
* @private
* @param {ObjectArray} pkgs - package data
* @param {string} pattern - glob pattern
* @param {Callback} clbk - callback to invoke upon completion
*
* @example
* var licenses = require( '@stdlib/_tools/licenses/licenses' );
*
* var pattern = '{readme*,licen[cs]e*,copying*}';

Check warning on line 47 in lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unknown word: "licen"
*
* licenses( onResults );
*
* function onResults( error, results ) {
* if ( error ) {
* throw error;
* }
* infer( results, pattern, onInfer );
* }
*
* function onInfer( error, results ) {
* if ( error ) {
* throw error;
* }
* console.dir( results );
* }
*/
function infer( pkgs, pattern, clbk ) {
var count;
Expand Down
Loading