Skip to content

Commit

Permalink
Fix function comments based on best practices from Effective Go
Browse files Browse the repository at this point in the history
Signed-off-by: CodeLingo Bot <bot@codelingo.io>
  • Loading branch information
CodeLingoBot committed Feb 28, 2019
1 parent 97cc6d1 commit 95b0c16
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions browser.go
Original file line number Diff line number Diff line change
Expand Up @@ -134,13 +134,13 @@ func (p *UserAgent) detectBrowser(sections []section) {
}
}

// Returns two strings. The first string is the name of the engine and the
// Engine returns two strings. The first string is the name of the engine and the
// second one is the version of the engine.
func (p *UserAgent) Engine() (string, string) {
return p.browser.Engine, p.browser.EngineVersion
}

// Returns two strings. The first string is the name of the browser and the
// Browser returns two strings. The first string is the name of the browser and the
// second one is the version of the browser.
func (p *UserAgent) Browser() (string, string) {
return p.browser.Name, p.browser.Version
Expand Down
8 changes: 4 additions & 4 deletions operating_systems.go
Original file line number Diff line number Diff line change
Expand Up @@ -282,17 +282,17 @@ func (p *UserAgent) detectOS(s section) {
}
}

// Returns a string containing the platform..
// Platform returns a string containing the platform..
func (p *UserAgent) Platform() string {
return p.platform
}

// Returns a string containing the name of the Operating System.
// OS returns a string containing the name of the Operating System.
func (p *UserAgent) OS() string {
return p.os
}

// Returns a string containing the localization.
// Localization returns a string containing the localization.
func (p *UserAgent) Localization() string {
return p.localization
}
Expand Down Expand Up @@ -325,7 +325,7 @@ func osName(osSplit []string) (name, version string) {
return name, version
}

// Returns combined information for the operating system.
// OSInfo returns combined information for the operating system.
func (p *UserAgent) OSInfo() OSInfo {
// Special case for iPhone weirdness
os := strings.Replace(p.os, "like Mac OS X", "", 1)
Expand Down
8 changes: 4 additions & 4 deletions user_agent.go
Original file line number Diff line number Diff line change
Expand Up @@ -164,23 +164,23 @@ func (p *UserAgent) Parse(ua string) {
}
}

// Returns the mozilla version (it's how the User Agent string begins:
// Mozilla returns the mozilla version (it's how the User Agent string begins:
// "Mozilla/5.0 ...", unless we're dealing with Opera, of course).
func (p *UserAgent) Mozilla() string {
return p.mozilla
}

// Returns true if it's a bot, false otherwise.
// Bot returns true if it's a bot, false otherwise.
func (p *UserAgent) Bot() bool {
return p.bot
}

// Returns true if it's a mobile device, false otherwise.
// Mobile returns true if it's a mobile device, false otherwise.
func (p *UserAgent) Mobile() bool {
return p.mobile
}

// Returns the original given user agent.
// UA returns the original given user agent.
func (p *UserAgent) UA() string {
return p.ua
}

0 comments on commit 95b0c16

Please sign in to comment.