Skip to content

Commit

Permalink
docs: 📝 correct/update/extend documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
CourtHive committed Mar 27, 2024
1 parent a5c89b1 commit 83814e2
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
12 changes: 12 additions & 0 deletions documentation/docs/apis/tools-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,14 +201,26 @@ const { valid, error } = tools.tieFormatGenderValidityCheck({

## unique

```js
engine.unique([]); // returns unique members of an array
```

---

## UUID

```js
engine.UUID(); // generates unique identifier
```

---

## UUIDS

```js
engine.UUIDS(count); // generates count unique identifiers
```

---

## validateTieFormat
Expand Down
6 changes: 3 additions & 3 deletions documentation/docs/governors/event-governor.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,6 @@ If attributes are combined will sanity check correspondence and return an array

```js
const {
} = engine.getCategoryAgeDetails({
consideredDate, // returns either supplied value or date when invoked
combinedAge, // boolean indicating that ageMax and ageMin are combined values
ageMaxDate,
Expand Down Expand Up @@ -178,8 +177,9 @@ event.modifyEvent({
eventGender, // optional - must validate against current event entries, if any
eventType, // optional - must validate against current event entries, if any
eventName, // optional
startDate, // optional
endDate, // optional
startDate, // optional - must fall within tournament dates
category, // optional - must validate against current event entries, if any
endDate, // optional - must fall within tournament dates
},
eventId,
});
Expand Down

0 comments on commit 83814e2

Please sign in to comment.