Skip to content
This repository was archived by the owner on Jun 12, 2026. It is now read-only.
This repository was archived by the owner on Jun 12, 2026. It is now read-only.

Generated docs for Golang is in the wrong format #123

Open

Description

@maggie44

Generating inline code documentation with Mintlify for a function in Golang current displays like this:

// This function creates a Kubernetes network policy and waits for it to be created or times out.
func createNetworkPolicy(
	...
}

Golang inline note conventions however, start with the name of the function being documented, and should be like this:

// createNetworkPolicy creates a Kubernetes network policy and waits for it to be created or times out.
func createNetworkPolicy(
	...
}

Some editors like goLand have linters built in to check for this convention.

More info can be found in the Golang docs: https://go.dev/doc/comment

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions