Skip to content

docs(util): added jsdoc annotations for ArrayHelpers.js#15279

Merged
sokra merged 1 commit intowebpack:mainfrom
taranek:docs/array-helpers-docs
Jan 31, 2022
Merged

docs(util): added jsdoc annotations for ArrayHelpers.js#15279
sokra merged 1 commit intowebpack:mainfrom
taranek:docs/array-helpers-docs

Conversation

@taranek
Copy link
Copy Markdown
Contributor

@taranek taranek commented Jan 30, 2022

Hi there, it's my first contribution to this repo, so I tried to find something easy to make my debut smoother. I hope I won't break contribution guidelines🤞

What kind of change does this PR introduce?

Adds missing JSDoc type annotations for util/ArrayHelpers.js file.
Improves type safety of groupBy and equals util methods by providing an optional type parameter representing the type of a single array element (which defaults to any).

Did you add tests for your changes?

No.

Does this PR introduce a breaking change?

No.

What needs to be documented once your changes are merged?

Nothing - it's just a small improvement of the existing documentation.

@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented Jan 30, 2022

CLA Signed

The committers are authorized under a signed CLA.

@webpack-bot
Copy link
Copy Markdown
Contributor

For maintainers only:

  • This needs to be documented (issue in webpack/webpack.js.org will be filed when merged)
  • This needs to be backported to webpack 4 (issue will be created when merged)

@taranek taranek force-pushed the docs/array-helpers-docs branch from 3cf3f49 to c13e088 Compare January 30, 2022 22:40
@taranek taranek force-pushed the docs/array-helpers-docs branch from c13e088 to 5a3760e Compare January 30, 2022 22:42
@sokra sokra merged commit 6f3735c into webpack:main Jan 31, 2022
@sokra
Copy link
Copy Markdown
Member

sokra commented Jan 31, 2022

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants