fix: docs

Signed-off-by: Carlos A Becker <[email protected]>
caarlos0 · Mar 23, 2022 · cc60d39 · cc60d39
1 parent 1d6336e
commit cc60d39
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -63,10 +63,12 @@ Finally, it prints a rank by each category.
 
 
 Important notes:
-* The ` + "`" + `--since` + "`" + ` filter does not work "that well" because GitHub summarizes thedata by week, so the data is not as granular as it should be.
-* The ` + "`" + `--include-reviews` + "`" + ` only grabs reviews from users that had contributions on the previous step.
-* In the ` + "`" + `--blacklist` + "`" + ` option, 'foo' blacklists both the 'foo' user and 'foo' repo, while 'user:foo' blacklists only the user and 'repo:foo' only the repository.
-* The ` + "`" + `--since` + "`" + ` option accepts all the regular time.Durations Go accepts, plus a few more: 1y (365d), 1mo (30d), 1w (7d) and 1d (24h).`,
+* The ` + "`--since`" + ` filter does not work "that well" because GitHub summarizes thedata by week, so the data is not as granular as it should be.
+* The ` + "`--include-reviews`" + ` only grabs reviews from users that had contributions on the previous step.
+* In the ` + "`--blacklist`" + ` option, 'foo' blacklists both the 'foo' user and 'foo' repo, while 'user:foo' blacklists only the user and 'repo:foo' only the repository.
+* The ` + "`--since`" + ` option accepts all the regular time. Accepts any duration Go standard library accepts, plus a few more: 1y (365d), 1mo (30d), 1w (7d) and 1d (24h).
+* The ` + "`--token`" + ` token permissions need to include 'repo - Full control of private repositories'. Required only if you need to fetch data from private repositories in your organization.
+}`,
 	PreRun: func(cmd *cobra.Command, args []string) {
 		if token == "" {
 			token = os.Getenv("GITHUB_TOKEN")

diff --git a/docs/org-stats.md b/docs/org-stats.md
@@ -16,8 +16,10 @@ Important notes:
 * The `--since` filter does not work "that well" because GitHub summarizes thedata by week, so the data is not as granular as it should be.
 * The `--include-reviews` only grabs reviews from users that had contributions on the previous step.
 * In the `--blacklist` option, 'foo' blacklists both the 'foo' user and 'foo' repo, while 'user:foo' blacklists only the user and 'repo:foo' only the repository.
-* The `--since` option accepts all the regular time.Durations Go accepts, plus a few more: 1y (365d), 1mo (30d), 1w (7d) and 1d (24h).
-* The `--token` token permissions need to include 'repo - Full control of private repositories'. Required only if you need to fetch data from private repositories in your organisation.
+* The `--since` option accepts all the regular time. Accepts any duration Go standard library accepts, plus a few more: 1y (365d), 1mo (30d), 1w (7d) and 1d (24h).
+* The `--token` token permissions need to include 'repo - Full control of private repositories'. Required only if you need to fetch data from private repositories in your organization.
+}
+
 ```
 org-stats [flags]
 ```