Skip to content

Improve JSDoc documentation on findMany operations #5509

@jasonkuhrt

Description

@jasonkuhrt

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueAlways wanted to get involved in an open source project but don’t know where to begin? Welcome!topic: prisma-client

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions