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

Enhance JSDoc sentences of word module #2937

Closed
Shinigami92 opened this issue Jun 6, 2024 · 1 comment · Fixed by #2963
Closed

Enhance JSDoc sentences of word module #2937

Shinigami92 opened this issue Jun 6, 2024 · 1 comment · Fixed by #2963
Assignees
@Shinigami92
Labels
c: docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed m: word Something is referring to the word module p: 1-normal Nothing urgent
Milestone
vAnytime

Comments

@Shinigami92
Copy link
Member

Right now there are JSDoc sentences like Returns a random sample of random or optionally specified length. and IMO they are really hard to fully understand.

  • What is a sample?
  • What is a "sample of random"?
  • Or is it read like "random or optional..."?
  • What is the length referring to?

Maybe I also just have issues with processing the description because I read the english text with a german brain 🧠
@Shinigami92 Shinigami92 added c: docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed p: 1-normal Nothing urgent m: word Something is referring to the word module labels Jun 6, 2024
@Shinigami92 Shinigami92 added this to the vAnytime milestone Jun 6, 2024
@matthewmayer
Copy link
Contributor

i would just simplify e.g.

  • Returns a random sample of random or optionally specified length. -> Returns a random word
  • Returns a verb of random or optionally specified length. -> Returns a random verb

The fact that there's an option to control word length is fine to just mention in the documentation of the parameters.

@Shinigami92 Shinigami92 self-assigned this Jun 21, 2024
@Shinigami92 Shinigami92 mentioned this issue Jun 21, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Shinigami92 Shinigami92

Labels
c: docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed m: word Something is referring to the word module p: 1-normal Nothing urgent
Projects
None yet
Milestone
vAnytime
Development

Successfully merging a pull request may close this issue.

docs: simplify word description sentences faker-js/faker
2 participants
@matthewmayer @Shinigami92