DOC-5043 sample of Cursor AI-generated doc comments#2918
Closed
andy-stark-redis wants to merge 1 commit intoredis:masterfrom
andy-stark-redis:DOC-5043-js-docs-with-ai
Closed
DOC-5043 sample of Cursor AI-generated doc comments#2918andy-stark-redis wants to merge 1 commit intoredis:masterfrom andy-stark-redis:DOC-5043-js-docs-with-ai
andy-stark-redis wants to merge 1 commit intoredis:masterfrom
andy-stark-redis:DOC-5043-js-docs-with-ai
Conversation
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: 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, |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
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
npm testpass with this change (including linting)?