Skip to content

Conversation

@Emyrk
Copy link
Member

@Emyrk Emyrk commented Oct 16, 2025

Converts Golang style docs to JSDocs format.

The mutation NoJSDocTransform exists to prevent this reformatting.

Golang docs are not formatted for VSCode and other editors to properly pick up the docs for a given type/field. So converting to the /** */ preserves the original intention of the comments.

Related issues:

Example:

// CommentedStructure is a struct with a comment.
type CommentedStructure struct {
}

To

// From comments/comments.go
/**
 * CommentedStructure is a struct with a comment.
 */
export interface CommentedStructure {
}

@Emyrk
Copy link
Member Author

Emyrk commented Oct 16, 2025

@stavros-k just a heads up on this upcoming change.

@Emyrk Emyrk merged commit 3be15ad into main Oct 16, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant