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

Incorrect example naming for struct methods (with suffix) #47

Closed
jackbackes opened this issue Aug 19, 2021 · 1 comment · Fixed by #51
Closed

Incorrect example naming for struct methods (with suffix) #47

jackbackes opened this issue Aug 19, 2021 · 1 comment · Fixed by #51

Comments

@jackbackes
Copy link

I have an example function in my code as follows:

func ExampleClient_Update_unset() {
   ...
}

godoc renders the name as Example (Unset):

image

gomarkdoc renders the name as Example:


<details><summary>Example</summary>
<p>

image

Here is the relevant documentation from the testing library:

image

@jackbackes jackbackes changed the title Example naming for struct methods? Incorrect example naming for struct methods (with suffix) Aug 19, 2021
@princjef
Copy link
Owner

Thanks for reporting this issue! I've found the problem in the code and am working on testing out a fix

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 a pull request may close this issue.

2 participants