Skip to content

Commit

Permalink
Add a little more documentation for containers
Browse files Browse the repository at this point in the history
  • Loading branch information
brandur committed Jun 13, 2018
1 parent 7130a47 commit 22bc1f5
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions params.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,16 @@ const (
StartingAfter = "starting_after"
)

// ParamsContainer is a general interface for which all parameter structs
// should comply. They achieve this by embedding a Params struct and inheriting
// its implementation of this interface.
type ParamsContainer interface {
GetParams() *Params
}

// ListParamsContainer is a general interface for which all list parameter
// structs should comply. They achieve this by embedding a ListParams struct
// and inheriting its implementation of this interface.
type ListParamsContainer interface {
GetListParams() *ListParams
}
Expand Down

0 comments on commit 22bc1f5

Please sign in to comment.