writer
writer copied to clipboard
Generated docs for Golang is in the wrong format
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