Skip to content

Commit

Permalink
docs: update documentation (#83)
Browse files Browse the repository at this point in the history
  • Loading branch information
muktihari authored Jan 2, 2024
1 parent 0515bd4 commit 74224ed
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion decoder/decoder.go
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ func WithNoComponentExpansion() Option {
// To decode chained FIT files, use Next() to check if r hasn't reach EOF and next bytes are still a valid FIT sequences.
//
// for dec.Next() {
// fit, err := dec.Decode(context.Background())
// fit, err := dec.Decode()
// }
//
// Note: We encourage wrapping r into a buffered reader such as bufio.NewReader(r),
Expand Down
2 changes: 1 addition & 1 deletion encoder/encoder.go
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ func New(w io.Writer, opts ...Option) *Encoder {
// Multiple Fit files can be chained together into a single Fit file by calling Encode for each fit data.
//
// for _, fit := range fits {
// err := enc.Encode(context.Background(), fit)
// err := enc.Encode(fit)
// }
//
// Encode chooses which strategy to use for encoding the data based on given writer and let the chosen strategy do the work.
Expand Down

0 comments on commit 74224ed

Please sign in to comment.