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

Generated docs for Golang is in the wrong format #123

Open
maggie44 opened this issue Jun 21, 2023 · 0 comments
Open

Generated docs for Golang is in the wrong format #123

maggie44 opened this issue Jun 21, 2023 · 0 comments

Comments

@maggie44
Copy link

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

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

No branches or pull requests

1 participant