Skip to content
This repository has been archived by the owner on Jan 16, 2021. It is now read-only.

Formatting of multi-line parameter list #657

Open
gonutz opened this issue Nov 5, 2019 · 1 comment
Open

Formatting of multi-line parameter list #657

gonutz opened this issue Nov 5, 2019 · 1 comment

Comments

@gonutz
Copy link

gonutz commented Nov 5, 2019

Look at the function BuildAudioCVT on this godoc page in the Index section. Its parameter list is formatted like this:

func BuildAudioCVT( cvt *AudioCVT, srcFormat AudioFormat, srcChannels uint8, srcRate int, dstFormat AudioFormat, dstChannels uint8, dstRate int, ) (converted bool, err error)

There is an extra space at the start of the parameter list and an extra comma at the end of it.
It should really look like this:

func BuildAudioCVT(cvt *AudioCVT, srcFormat AudioFormat, srcChannels uint8, srcRate int, dstFormat AudioFormat, dstChannels uint8, dstRate int) (converted bool, err error)

The code has each parameter declared on its owl line. This cases the issue.

@gonutz
Copy link
Author

gonutz commented May 7, 2020

The given link does not fail anymore due to changes in the code. That is why I created a separate repo to showcase the problem:

https://godoc.org/github.com/gonutz/godoc_org_test

Note that when I use go tool doc on this locally, it shows everything fine.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant