Skip to content

Fix function comments based on best practices from Effective Go #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Daanikus wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix function comments based on best practices from Effective Go #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions yquotes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ func NewStock(symbol string, history bool) (*Stock, error) {
return stock, nil
}

// Get single stock price data.
// GetPrice gets single stock price data.
func GetPrice(symbol string) (*Price, error) {
data, err := loadSingleStockPrice(symbol)
if err != nil {
Expand All @@ -131,7 +131,7 @@ func GetPrice(symbol string) (*Price, error) {
return price, nil
}

// Get single stock price for certain date.
// GetPriceForDate gets single stock price for certain date.
func GetPriceForDate(symbol string, date time.Time) (PriceH, error) {
var price PriceH
// We need to get price information for single date, so date passed to
Expand All @@ -151,7 +151,7 @@ func GetPriceForDate(symbol string, date time.Time) (PriceH, error) {
return price, nil
}

// Get historical prices for the stock.
// GetDailyHistory gets historical prices for the stock.
func GetDailyHistory(symbol string, from, to time.Time) ([]PriceH, error) {
var prices []PriceH
// Create URL with daily frequency of data.
Expand All @@ -168,7 +168,7 @@ func GetDailyHistory(symbol string, from, to time.Time) ([]PriceH, error) {
return prices, nil
}

// Get stock price history for number of years backwards.
// HistoryForYears gets stock price history for number of years backwards.
func HistoryForYears(symbol string, years int, period string) ([]PriceH, error) {
var prices []PriceH
duration := time.Duration(int64(time.Hour) * 24 * 365 * int64(years))
Expand Down