Skip to content
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.

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

Port documentation to JSDoc for joinUrl #957

Merged
merged 1 commit into from
Dec 19, 2023

Conversation

mxdvl
Copy link
Contributor

@mxdvl mxdvl commented Nov 26, 2023

What are you changing?

  • Port joinUrl documentation from Markdown to JSDoc
  • Make joinUrl arguments are now readonly

Why?

  • Better documentation inside the IDE
  • readonly arguments which ensures no mutation of the input is permitted inside the function body, without any impact on consumers.

Copy link

changeset-bot bot commented Nov 26, 2023

🦋 Changeset detected

Latest commit: 72da15f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@guardian/libs Patch
@csnx/npm-package Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added 📦 npm Affects a @guardian package on NPM @guardian/libs labels Nov 26, 2023
@mxdvl mxdvl force-pushed the mxdvl/readonly-arrays-as-arguments branch from d9ba4c7 to 694452f Compare November 26, 2023 14:03
Also make the array of arguments `readonly`, which ensures
no mutation of the input is permitted inside the function body.

Slightly reword the documentation.
@mxdvl mxdvl force-pushed the mxdvl/readonly-arrays-as-arguments branch from 694452f to 72da15f Compare December 18, 2023 16:34
@mxdvl mxdvl marked this pull request as ready for review December 18, 2023 16:34
@mxdvl mxdvl requested a review from a team as a code owner December 18, 2023 16:34
@mxdvl mxdvl requested a review from a team December 18, 2023 16:34
@mxdvl mxdvl requested review from a team as code owners December 18, 2023 16:34
@mxdvl mxdvl changed the title docs(joinUrl): port documentation to JSDoc Port documentation to JSDoc for joinUrl Dec 18, 2023
@mxdvl mxdvl added the run_chromatic Runs chromatic when label is applied label Dec 19, 2023
@mxdvl mxdvl merged commit f85e2a4 into main Dec 19, 2023
26 checks passed
@mxdvl mxdvl deleted the mxdvl/readonly-arrays-as-arguments branch December 19, 2023 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@guardian/libs 📦 npm Affects a @guardian package on NPM run_chromatic Runs chromatic when label is applied
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants