EPIC: Add JSDoc descriptions

[Shinigami92]

Clear and concise description of the problem

Most (if not all) of the functions already have JSDoc, but these are just simple e.g. @param <fieldName> without the descriptive text.
We found some documentation like #160, https://fakerjs.dev/api/datatype and e.g. these schema definitions that were just for generating documentation.

Suggested solution

We would like to write these messages to the JSDoc comments, so that IDEs like VSCode can provide them via tooltips.

Alternative

No response

Additional context

After this is done, we think that we can remove the schema definitions.

Module	Assignees	#PR	Done
address.ts	@mbokinala, @ST-DDT	#230	✔️
animal.ts	@mbokinala	#250, #417	✔️
commerce.ts	@ST-DDT	#351	✔️
company.ts	@ST-DDT	#423	✔️
database.ts	@ST-DDT	#424	✔️
datatype.ts	@pkuczynski	#337	✔️
date.ts	@ST-DDT	#427	✔️
fake.ts	@ST-DDT	#406	✔️
finance.ts	@ST-DDT	#434	✔️
git.ts	@ST-DDT	#435	✔️
hacker.ts	@ST-DDT	#436	✔️
helpers.ts	@ST-DDT	#442	✔️
image.ts	@ST-DDT	#437	✔️
internet.ts	@ST-DDT	#447	✔️
lorem.ts	@ST-DDT	#458	✔️
mersenne.ts	@ST-DDT	#438	✔️
music.ts	@ST-DDT	#390	✔️
name.ts	@ST-DDT	#391	✔️
phone.ts	@pkuczynski	#397	✔️
random.ts	@pkuczynski @ST-DDT	#408 #562	✔️
system.ts	@pkuczynski	#298	✔️
time.ts	@pkuczynski	#288	✔️
unique.ts	@ST-DDT	#439	✔️
vehicle.ts	@pkuczynski	#274	✔️
word.ts	@pkuczynski	#273	✔️

[github-actions]

Hello @Shinigami92. We like your proposal/feedback and would appreciate a contribution via a Pull Request by you or another community member. We thank you in advance for your contribution and are looking forward to reviewing it!

[mbokinala]

@Shinigami92 I can work on this

[import-brain]

@Shinigami92 Please assign to @mbokinala, thanks

[Shinigami92]

Please not that it is very much to do in this PR. Maybe split it and multiple contributors can open PRs, communicating here or via Discord who is on which part or so.
That would also be easier to review.

[mbokinala]

Maybe split it and multiple contributors can open PRs, communicating here or via Discord who is on which part or so.

Sounds good, shall we coordinate it on Discord?

[fzn0x]

Maybe split it and multiple contributors can open PRs, communicating here or via Discord who is on which part or so.

Sounds good, shall we coordinate it on Discord?

Yup we actively discussing everything about faker there :)

[pkuczynski]

If you need some help, I can jump in... I am not using discord much, but I can follow on the comment here...

[Shinigami92]

Take a look at #230 and #250
Just do exactly that for the other modules 🙂

[pkuczynski]

Take a look at #230 and #250
Just do exactly that for the other modules 🙂

Is there a list whos working on what, so I can put my name on it and avoid duplicating work?

[Shinigami92]

@pkuczynski https://github.com/orgs/faker-js/projects/2

[ST-DDT]

finance.ts will be my next one. #434

[ST-DDT]

I git it. #435

[ST-DDT]

hacker incoming.

[ST-DDT]

I can imageine doing another file now. #437

[ST-DDT]

I feel like a mersenneary right now. #438

[ST-DDT]

I couldn't think of a unique sentence to write here, just now. #439

[ST-DDT]

I would like to thank all our helpers that contributed their time to address these issues.
Once all PRs have been reviewed and merged, we can finally close this issue.
I will tackle the last unclaimed one now: helpers

[ST-DDT]

@pkuczynski Do you have time to create the jsdocs PRs for lorem and internet this week?

[pkuczynski]

This week might be hard. Go for it. Random I did most, I can finish that one

[ST-DDT]

Internet is now covered: #447

[ST-DDT]

Lorem is covered by #458

[ST-DDT]

I created the last PR for random.

[ST-DDT]

Finally done