Skip to content

Commit 4956d3f

Browse files
authored
Merge pull request github#321 from jdweiner526/jdweiner526-docfix-1
Jdweiner526 docfix 1
2 parents fe91e2f + 75f9fe4 commit 4956d3f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

api/ruby/find-inactive-members/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
```
44
find_inactive_members.rb - Find and output inactive members in an organization
55
-c, --check Check connectivity and scope
6-
-d, --date MANDATORY Date from which to start looking for activity
7-
-e, --email Fetch the user email (can make the script take longer
6+
-d, --date MANDATORY Date from which to start looking for activity (in a format parseable by the Ruby Date class: https://ruby-doc.org/stdlib/libdoc/date/rdoc/Date.html)
7+
-e, --email Fetch the user email (can make the script take longer)
88
-o, --organization MANDATORY Organization to scan for inactive users
99
-v, --verbose More output to STDERR
1010
-h, --help Display this help
1111
```
1212

13-
This utility finds users inactive since a configured date, writes those users to a file `inactive_users.csv`.
13+
This utility finds users inactive since the given date and writes those users to the file `inactive_users.csv`.
1414

1515
## Installation
1616

@@ -42,6 +42,11 @@ export OCTOKIT_API_ENDPOINT="https://<your_github_enterprise_instance>/api/v3" #
4242
ruby find_inactive_members.rb [-cehv] -o ORGANIZATION -d DATE
4343
```
4444

45+
## Examples
46+
```
47+
ruby find_inactive_members.rb -o YoyodynePropulsionSystems -d "Feb 10 2020"
48+
```
49+
4550
## How Inactivity is Defined
4651

4752
Members are defined as inactive if they **have not performed** any of the following actions in any repository in the specified **ORGANIZATION** since the specified **DATE**:

0 commit comments

Comments
 (0)