golang/gddo

Formatting of multi-line parameter list

gonutz opened this issue · 1 comments

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.

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.