search

rticommunity / rticonnextdds-connector-go

RTI Connector for Connext DDS is a lightweight technology that enables DDS data to be accessed with Go.
Other
26 stars 12 forks source link

Creating testable examples #10

Closed kyoungho closed 4 years ago

kyoungho commented 5 years ago

Proposal:

Creating testable examples displayed in Godoc documentation. https://blog.golang.org/examples

Current behavior:

There are no testable examples displayed in the API documentation.

Desired behavior:

Displaying testable examples in the API documentation. Examples can be used as tests.

Use case:

It will be useful for users to understand API when referring to Godoc API documentation. Examples can be used as tests as well.

kyoungho commented 5 years ago

Added some testable examples.

https://godoc.org/github.com/rticommunity/rticonnextdds-connector-go#pkg-examples https://github.com/rticommunity/rticonnextdds-connector-go/blob/master/example_test.go