Skip to content

Commit

Permalink
Improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Michaelvilleneuve committed Dec 8, 2023
1 parent d11867d commit 42cdd13
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ If you want to use this method outside of a counter, you can include `include St

| Parameter | Type | Description |
|------------|---------------|-------------------------------------------------------------|
| `scope` | Object | The scope of the counter, which can be an Organisation or a Department. |
| `scope` | Object, optional | The scope of the counter. See scope option above |
| `start_at` | Date, optional| The date from which you want to start counting. If not provided, counts from the beginning. |
| `stop_at` | Date, optional| The date at which you want to stop counting. If not provided, counts up to the current date. |

Expand All @@ -198,7 +198,7 @@ This method returns the value of the counter.

| Parameter | Type | Description |
|------------|---------------|-------------------------------------------------------------|
| `scope` | Object | The scope of the counter, which can be an Organisation or a Department. |
| `scope` | ActiveRecord instance, optional | The scope of the counter. See scope option above |
| `month` | Date, optional| The month for which you want to get the value. If not provided, returns the value for the current month. |

### .sum
Expand All @@ -208,7 +208,7 @@ This method returns the sum of the values of the counter.

| Parameter | Type | Description |
|------------|---------------|-------------------------------------------------------------|
| `scope` | Object | The scope of the counter, which can be an Organisation or a Department. |
| `scope` | ActiveRecord instance, optional | The scope of the counter. See scope option above |
| `month` | Date, optional| The month for which you want to get the value. If not provided, returns the value for the current month. |

### .average
Expand All @@ -218,7 +218,7 @@ This method returns the average of the values of the counter.

| Parameter | Type | Description |
|------------|---------------|-------------------------------------------------------------|
| `scope` | Object | The scope of the counter, which can be an Organisation or a Department. |
| `scope` | ActiveRecord instance, optional | The scope of the counter. See scope option above |
| `month` | Date, optional| The month for which you want to get the value. If not provided, returns the value for the current month. |

## Development
Expand Down

0 comments on commit 42cdd13

Please sign in to comment.