Skip to content

Commit 84ff3b4

Browse files
committed
docs: Improve doc comments
1 parent fc09bdb commit 84ff3b4

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

hackernews.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ type HackerNewsResponse struct {
2525
}
2626

2727
// SearchHackerNews query HN Search API for given prompt. It returns list of
28-
// stories which contains comments sorted by relevance, then popularity, then
29-
// number of comments.
28+
// discussions sorted by relevance, then popularity, then number of comments.
3029
//
3130
// See: https://hn.algolia.com/api
3231
func SearchHackerNews(ctx context.Context, client http.Client, query string) ([]Discussion, error) {

lobsters.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import (
99
"github.com/macie/opinions/http"
1010
)
1111

12-
// SearchLobsters query lobster search engine for given prompt. It returns list
13-
// of stories which contains comments sorted by relevance.
12+
// SearchLobsters query Lobsters search engine for given prompt. It returns list
13+
// of discussions sorted by relevance.
1414
func SearchLobsters(ctx context.Context, client http.Client, query string) ([]Discussion, error) {
1515
discussions := make([]Discussion, 0)
1616
searchURL := "https://lobste.rs/search?what=stories&order=relevance&q="

0 commit comments

Comments
 (0)