Documentation on PullConsumeOpt and PullMessagesOpt is not clear

[ohler55]

Observed behavior

PullConsumeOpt and PullMessagesOpt interfaces includes not only functions such as ConsumeErrHandler() but also some undocumented options such as the StopAfter type. The documentation on the StopAfter type indicated it sets the number of messages but it does not indicated how or what is needed to do that. The same is true of the following:

• PullExpiry
• PullMaxBytes
• PullHeartbeat
• PullMaxMessages
• PullThresholdBytes
• PullThresholdMessages

Expected behavior

I would expect the documentation for each type to include a statement that is implements the PullConsumeOpt interface or which ever interfaces it implements as related to the API.

Server and client version

https://pkg.go.dev/github.com/nats-io/nats.go/jetstream v1.37.0

Host environment

Any browser on any platform.

Steps to reproduce

Access the https://pkg.go.dev/github.com/nats-io/nats.go/jetstream page.

[piotrpio]

Hello @ohler55, thank you for submitting the issue! I agree, the documentation for those options is lacking, I'll update it.