BooleanCat / go-functional

go-functional is a library of iterators to augment the standard library

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Bug πŸ›]: Example specs not visible in reference docs for Option and Result packages

BooleanCat opened this issue Β· comments

What happened?

When browsing the reference documentation, the Option and Result packages do not have any examples visible.

What did you expect to happen?

I expect to see examples for each function and receiver in both the Option and Result packages' reference documentation.

Which version of go-functional were you using?

v0.4.0

To Reproduce

Visit the reference documentation and observe the missing examples.

Do you intend to fix this issue yourself?

Not at the moment.

Additional context

There are example tests in the packages' source, but for some reason it isn't rendered in the reference documentation.

If I render the docs using godoc -http=:6060, the examples are visible so perhaps there's something particular about https://pkg.go.dev

Looks like this issue is resolved - I just checked the reference docs and the examples are all there.