We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
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
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Generating inline code documentation with Mintlify for a function in Golang current displays like this:
Golang inline note conventions however, start with the name of the function being documented, and should be like this:
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
The text was updated successfully, but these errors were encountered: