Sitelet https://web.archive.org/web/20220402194242/https://github.com/prisma/prisma/issues/5509
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

Improve JSDoc documentation on findMany operations #5509

Open
jasonkuhrt opened this issue Feb 6, 2021 · 3 comments
Open

Improve JSDoc documentation on findMany operations #5509

jasonkuhrt opened this issue Feb 6, 2021 · 3 comments
Labels
good first issue kind/improvement team/client topic: prisma-client

Comments

@jasonkuhrt
Copy link
Member

@jasonkuhrt jasonkuhrt commented Feb 6, 2021

I am intentionally making this issue specific but I assume it could be expanded to include much more of the API.

Problem

I do not have the entire Prisma Client API perfectly (let alone roughly) committed to memory.

When I go to use it to query for many results the operations tell me nothing about what and why they will do. I only have types to work with.

I don't want to open my browser, and knowing where to look online would take more than a few seconds to figure out.

image

Suggested solution

Please inline all or some of the excellent docs found somewhere on the Prisma website into the JSDoc for the respective operations for findMany.

Likely it doesn't make sense to recreate the website content in the JSDoc so please also link from the operation JSDoc to the website doc counterpart.

Alternatives

There is only JSDoc.

Additional context

I really don't like the idea of having to go navigate the web to learn basics about the API.

@Jolg42 Jolg42 added kind/improvement team/client topic: prisma-client process/candidate good first issue labels Feb 8, 2021
@imskr
Copy link

@imskr imskr commented Feb 13, 2021

Can I work on this issue?

@timsuchanek timsuchanek self-assigned this Feb 17, 2021
@timsuchanek timsuchanek removed the process/candidate label Feb 17, 2021
@matthewmueller matthewmueller added this to the 2.18.0 milestone Feb 17, 2021
@timsuchanek
Copy link
Contributor

@timsuchanek timsuchanek commented Feb 18, 2021

Yes, @imskr you can give it a try!
You can give it a try here https://github.com/prisma/prisma/blob/master/src/packages/client/src/generation/TSClient/jsdoc.ts

You'll need to update the snapshots of the exhaustive schema test:

cd src/packages/client
pnpm run test exhaustive -- -u

@matthewmueller matthewmueller removed this from the 2.18.0 milestone Mar 3, 2021
@matthewmueller matthewmueller added this to the 2.19.0 milestone Mar 3, 2021
@matthewmueller matthewmueller removed this from the 2.19.0 milestone Mar 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue kind/improvement team/client topic: prisma-client
Projects
None yet
Development

No branches or pull requests

7 participants
@matthewmueller @jasonkuhrt @timsuchanek @Jolg42 @williamluke4 @imskr and others