Skip to content

Commit ad59032

Browse files
committed
Clarify Period Option Help Message
- Add examples for querying organization and user repositories with the `--period` option. - Include examples for using the `-hf` option with the `--period` option. - Explain that the `--period` option converts the specified time range to UTC date time.
1 parent e6253f1 commit ad59032

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

good_first_issues/commands/search.py

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,28 @@
1515

1616
period_help_msg = """
1717
Specify a time range for filtering data.
18+
Converts the specified time range to UTC date time.
1819
19-
Converts the specified time range to UTC date time
20+
# Query all organization repos
21+
$ gfi search "rust-lang" --period "30 hours"
22+
23+
# Query a specific repo in an organization
24+
$ gfi search "rust-lang" --repo "rust" -p "30 mins"
25+
26+
# Query repos with the topic hacktoberfest
27+
$ gfi search -hf -p "100 days"
28+
29+
# Query all user repos
30+
$ gfi search "yankeexe" --user -p "600 hrs"
31+
32+
# Query a specific repo of a user
33+
$ gfi search "yankeexe" --user --repo "good-first-issues" -p "600 days"
2034
2135
--period 1 m,min,mins,minutes
2236
2337
--period 2 h,hr,hour,hours,hrs
2438
2539
--period 3 d,day,days
26-
2740
"""
2841

2942

0 commit comments

Comments
 (0)