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

DOC-5043 sample of Cursor AI-generated doc comments #2918

Conversation

andy-stark-redis
Copy link

@andy-stark-redis andy-stark-redis commented Mar 27, 2025

Description

Describe your pull request here

DOC-5043

This is an attempt to add API doc comments using the AI tools in Cursor. The work here is nowhere near complete - for now, this is just to get some feedback about the quality and accuracy of the comments so far. I'll add more docs once we're happy with the overall standard.


Checklist

  • Does npm test pass with this change (including linting)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?

@andy-stark-redis andy-stark-redis self-assigned this Mar 27, 2025
@andy-stark-redis andy-stark-redis marked this pull request as ready for review March 27, 2025 14:17
@bobymicroby
Copy link
Member

Hi Andy,

Thanks for your work on the documentation PR. After reviewing it, I need to close it for now as it doesn't align with our documentation needs. We don't need redundant comments that state the obvious like this one:

/**
 * Represents a boolean response in Redis.
 */
export interface BooleanReply<

What we specifically need are tsdoc comments only for the parseCommand methods inside directories like client/lib/commands - not documentation for basic types or interfaces like the BooleanReply example. These command parsers are what IDEs will use to provide parameter hints and documentation to users.

Before we proceed with any documentation changes, I also need to verify if LSP/IDEs can correctly fetch these TSDoc comments given our unique approach to prototype inheritance in node-redis.

Thanks for your understanding,

@bobymicroby bobymicroby closed this Apr 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants