From 25119fd9e3af9bcc9ffa96963be9ab4c87078f76 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Oliver=20R=C3=BCmpelein?= <oli_r@fg4f.de>
Date: Fri, 8 Jan 2021 23:41:23 +0100
Subject: [PATCH] Add very simple docs.

---
 src/module/rolls/check.ts | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/module/rolls/check.ts b/src/module/rolls/check.ts
index e931f680..58cba71d 100644
--- a/src/module/rolls/check.ts
+++ b/src/module/rolls/check.ts
@@ -8,6 +8,19 @@ interface TermData {
     options: Record<string, unknown>;
 }
 
+/**
+ * Implements DS4 Checks as an emulated "dice throw".
+ *
+ * @notes
+ * Be aware that, even though this behaves like one roll, it actually throws several iones internally
+ *
+ * @example
+ * - Roll a check against a Check Target Number (CTV) of 18: `/r dsv18`
+ * - Roll a check with multiple dice against a CTN of 34: `/r dsv34`
+ * - Roll a check with a racial ability that makes `2` a coup and `19` a fumble: `/r dsv19c2,19`
+ * - Roll a check with a racial ability that makes `5` a coup and default fumble: `/r dsv19c5`
+ * - Roll a check with exploding dice: `/r dsv34x`
+ */
 export class DS4Check extends DiceTerm {
     constructor(termData: Partial<TermData>) {
         super({