From 8f5d035e92b6777bf2c6039ad31513a2ea755351 Mon Sep 17 00:00:00 2001 From: Carl Kittelberger Date: Sat, 25 Jun 2016 23:35:38 +0200 Subject: [PATCH] Move commentary for client methods to the actual interface. --- client.go | 34 ++++++++++++++++++++++++++------- req_fixture.go | 1 - req_fixtures.go | 1 - req_soccerseason.go | 1 - req_soccerseason_fixtures.go | 1 - req_soccerseason_leaguetable.go | 1 - req_soccerseason_teams.go | 1 - req_soccerseasons.go | 1 - req_team.go | 1 - req_team_fixtures.go | 1 - req_team_players.go | 1 - 11 files changed, 27 insertions(+), 17 deletions(-) diff --git a/client.go b/client.go index c801491..f689d06 100644 --- a/client.go +++ b/client.go @@ -16,16 +16,38 @@ Provides a high-level client to talk to the API that football-data.org offers. To create an instance please use NewClient(h). */ type Client interface { + // Fixture prepares a request to fetch the fixtures of a soccer season. Fixture(id uint64) FixtureRequest + + // Fixtures prepares a request to fetch the fixtures of a soccer season. Fixtures() FixturesRequest - SoccerSeason(id uint64) SoccerSeasonRequest + + // FixturesOfSoccerSeason prepares a request to fetch the fixtures of a soccer season. FixturesOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonFixturesRequest - LeagueTableOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonLeagueTableRequest - TeamsOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonTeamsRequest - SoccerSeasons() SoccerSeasonsRequest - Team(id uint64) TeamRequest + + // FixturesOfTeam prepares a request to fetch the fixtures of a soccer season. FixturesOfTeam(id uint64) TeamFixturesRequest + // LeagueTableOfSoccerSeason prepares a new request to fetch the league table of a given soccer season. + LeagueTableOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonLeagueTableRequest + + // PlayersOfTeam prepares a request to fetch a team's players. + PlayersOfTeam(id uint64) TeamPlayersRequest + + // SoccerSeason prepares a request to fetch the complete list of soccer seasons. + SoccerSeason(id uint64) SoccerSeasonRequest + + // SoccerSeasons prepares a request to fetch the complete list of soccer seasons. + SoccerSeasons() SoccerSeasonsRequest + + // Team prepares a request to fetch a team's information. + Team(id uint64) TeamRequest + + // TeamsOfSoccerSeason prepares a new request to fetch the league table of a given soccer season. + TeamsOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonTeamsRequest + + // SetToken sets the authentication token. + // Calling this method is *optional*. SetToken(authToken string) } @@ -48,8 +70,6 @@ func NewClient(h *http.Client) Client { return &client{httpClient: h} } -// SetToken sets the authentication token. -// Calling this method is *optional*. func (c *client) SetToken(authToken string) { c.AuthToken = authToken } diff --git a/req_fixture.go b/req_fixture.go index 3c43651..34c1e66 100644 --- a/req_fixture.go +++ b/req_fixture.go @@ -21,7 +21,6 @@ func (r FixtureRequest) Do() (s Fixture, err error) { return } -// Fixture prepares a request to fetch the fixtures of a soccer season. func (c *client) Fixture(id uint64) FixtureRequest { return FixtureRequest{c.req("fixture/%d", id)} } diff --git a/req_fixtures.go b/req_fixtures.go index e0f0c6e..de2426c 100644 --- a/req_fixtures.go +++ b/req_fixtures.go @@ -30,7 +30,6 @@ func (r FixturesRequest) Do() (s FixturesResponse, err error) { return } -// Fixtures prepares a request to fetch the fixtures of a soccer season. func (c *client) Fixtures() FixturesRequest { return FixturesRequest{c.req("fixtures")} } diff --git a/req_soccerseason.go b/req_soccerseason.go index fccaad9..2675d3a 100644 --- a/req_soccerseason.go +++ b/req_soccerseason.go @@ -13,7 +13,6 @@ func (r SoccerSeasonRequest) Do() (s SoccerSeason, err error) { return } -// SoccerSeason prepares a request to fetch the complete list of soccer seasons. func (c *client) SoccerSeason(id uint64) SoccerSeasonRequest { return SoccerSeasonRequest{c.req("soccerseasons/%d", id)} } diff --git a/req_soccerseason_fixtures.go b/req_soccerseason_fixtures.go index c026a1d..90b67a7 100644 --- a/req_soccerseason_fixtures.go +++ b/req_soccerseason_fixtures.go @@ -30,7 +30,6 @@ func (r SoccerSeasonFixturesRequest) Do() (s FixtureList, err error) { return } -// FixturesOfSoccerSeason prepares a request to fetch the fixtures of a soccer season. func (c *client) FixturesOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonFixturesRequest { return SoccerSeasonFixturesRequest{c.req("soccerseasons/%d/fixtures", soccerSeasonId)} } diff --git a/req_soccerseason_leaguetable.go b/req_soccerseason_leaguetable.go index 737653b..60ca8c4 100644 --- a/req_soccerseason_leaguetable.go +++ b/req_soccerseason_leaguetable.go @@ -21,7 +21,6 @@ func (r SoccerSeasonLeagueTableRequest) Do() (s SoccerSeason, err error) { return } -// LeagueTableOfSoccerSeason prepares a new request to fetch the league table of a given soccer season. func (c *client) LeagueTableOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonLeagueTableRequest { return SoccerSeasonLeagueTableRequest{c.req("soccerseasons/%d/leagueTable", soccerSeasonId)} } diff --git a/req_soccerseason_teams.go b/req_soccerseason_teams.go index e60a479..d821173 100644 --- a/req_soccerseason_teams.go +++ b/req_soccerseason_teams.go @@ -13,7 +13,6 @@ func (r SoccerSeasonTeamsRequest) Do() (s TeamList, err error) { return } -// TeamsOfSoccerSeason prepares a new request to fetch the league table of a given soccer season. func (c *client) TeamsOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonTeamsRequest { return SoccerSeasonTeamsRequest{c.req("soccerseasons/%d/leagueTable", soccerSeasonId)} } diff --git a/req_soccerseasons.go b/req_soccerseasons.go index 6b1408e..79cef56 100644 --- a/req_soccerseasons.go +++ b/req_soccerseasons.go @@ -21,7 +21,6 @@ func (r SoccerSeasonsRequest) Do() (s SoccerSeasonList, err error) { return } -// SoccerSeasons prepares a request to fetch the complete list of soccer seasons. func (c *client) SoccerSeasons() SoccerSeasonsRequest { return SoccerSeasonsRequest{c.req("soccerseasons")} } diff --git a/req_team.go b/req_team.go index c961502..67c06fd 100644 --- a/req_team.go +++ b/req_team.go @@ -20,7 +20,6 @@ func (r TeamRequest) Do() (s Team, err error) { return } -// Team prepares a request to fetch a team's information. func (c *client) Team(id uint64) TeamRequest { return TeamRequest{c.req("teams/%d", id), id} } diff --git a/req_team_fixtures.go b/req_team_fixtures.go index d63e03e..575f02a 100644 --- a/req_team_fixtures.go +++ b/req_team_fixtures.go @@ -36,7 +36,6 @@ func (r TeamFixturesRequest) Do() (s FixturesResponse, err error) { return } -// FixturesOfTeam prepares a request to fetch the fixtures of a soccer season. func (c *client) FixturesOfTeam(id uint64) TeamFixturesRequest { return TeamFixturesRequest{c.req("teams/%d/fixtures", id)} } diff --git a/req_team_players.go b/req_team_players.go index 099de3b..4f8656b 100644 --- a/req_team_players.go +++ b/req_team_players.go @@ -13,7 +13,6 @@ func (r TeamPlayersRequest) Do() (s PlayerList, err error) { return } -// PlayersOfTeam prepares a request to fetch a team's players. func (c *client) PlayersOfTeam(id uint64) TeamPlayersRequest { return TeamPlayersRequest{c.req("teams/%d/players", id)} }