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.

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

Jump to bottom

docs: fix jsdocs typos #2244

Merged
merged 1 commit into from Jul 8, 2023
Merged

docs: fix jsdocs typos #2244

merged 1 commit into from Jul 8, 2023

Conversation

RobinvanderVliet
Copy link
Contributor

No description provided.

@RobinvanderVliet RobinvanderVliet requested a review from a team July 7, 2023 19:41
@RobinvanderVliet RobinvanderVliet requested a review from a team as a code owner July 7, 2023 19:41
@import-brain import-brain added c: chore PR that doesn't affect the runtime behavior p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug labels Jul 7, 2023
@ST-DDT ST-DDT added the c: docs Improvements or additions to documentation label Jul 7, 2023
xDivisionByZerox
xDivisionByZerox approved these changes Jul 8, 2023
View reviewed changes
Copy link
Member

@xDivisionByZerox xDivisionByZerox left a comment

Choose a reason for hiding this comment

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

The changes look good. But, should the PR description have the topic docs instead of chore?

Shinigami92
Shinigami92 approved these changes Jul 8, 2023
View reviewed changes
Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

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

Seems the other maintainers don't have any concerns with the - dashes, so I'm also okay.
I just personally think the dashes are not necessary 🤷

@ST-DDT ST-DDT changed the title chore: Fix typos docs: fix jsdocs typos Jul 8, 2023
@ST-DDT ST-DDT merged commit 5a48282 into faker-js:next Jul 8, 2023
18 checks passed
@RobinvanderVliet RobinvanderVliet deleted the fix-typos branch July 9, 2023 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ST-DDT ST-DDT ST-DDT approved these changes

@Shinigami92 Shinigami92 Shinigami92 approved these changes

@import-brain import-brain import-brain approved these changes

@xDivisionByZerox xDivisionByZerox xDivisionByZerox approved these changes

Assignees
No one assigned
Labels
c: chore PR that doesn't affect the runtime behavior c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
None yet
Milestone
v8.x
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@RobinvanderVliet @ST-DDT @Shinigami92 @import-brain @xDivisionByZerox