@pavkam I didn't describe each option when there are object args, as there are already JSDoc descriptions on the properties themselves. I originally started down that road, but felt the likelihood of the duplication drifting was too high.

Personally when using IDE hints, I only read the function description for general usage, and then each option for more specificity, so went with that approach.

i.e. function:

property:

Thoughts?

@pavkam I didn't describe each option when there are object args, as there are already JSDoc descriptions on the properties themselves. I originally started down that road, but felt the likelihood of the duplication drifting was too high.

Personally when using IDE hints, I only read the function description for general usage, and then each option for more specificity, so went with that approach.

i.e. function:

property:

Thoughts?

I know some people prefer pure JSDoc to TS. I am by no means an expert in how these things work to be honest. I'll defer to your judgement.

Not an expert either, noted prisma/react/chakra/react-router just have a short description then link to docs. Will merge this for now as it's an improvement