From 44ccadef139acea24218cbc90f5f407b765c3281 Mon Sep 17 00:00:00 2001 From: Sven Koch <39488412+SVNKoch@users.noreply.github.com> Date: Sun, 22 Sep 2024 15:47:33 +0200 Subject: [PATCH 1/3] Readme: change parameter column type from optional to type Signed-off-by: Sven Koch <39488412+SVNKoch@users.noreply.github.com> --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index aeb3f71..6be3e23 100755 --- a/README.md +++ b/README.md @@ -102,38 +102,38 @@ The other attributes are the next due date, the last completed date, whether the This service can be called to mark a chore as completed. It will automatically schedule the next due date for the chore, and adjust future due dates if necessary (e.g. when scheduling "after" chores). -| Service Data Attribute | Optional | Description | +| Service Data Attribute | Type | Description | | ---------------------- | -------- | --------------------------------------------------------------------------------------- | -| `entity_id` | No | The entity ID of the chore or chores to complete. | -| `last_completed` | Yes | The date the chore was last completed. If not specified, the current date will be used. | +| `entity_id` | Required | The entity ID of the chore or chores to complete. | +| `last_completed` | Optional | The date the chore was last completed. If not specified, the current date will be used. | ### chore_helper.add_date This service can be called to add a due date to a chore manually. This is useful for custom chores that don't have any due dates scheduled automatically. -| Service Data Attribute | Optional | Description | +| Service Data Attribute | Type | Description | | ---------------------- | -------- | ---------------------------------------------------------- | -| `entity_id` | No | The entity ID of the chore or chores to add a due date to. | -| `date` | No | The date the chore is due. | +| `entity_id` | Required | The entity ID of the chore or chores to add a due date to. | +| `date` | Required | The date the chore is due. | ### chore_helper.offset_date This service can be called to offset the next due date of a chore. This will only affect the next due date for "every" chores, but will affect all future due dates for "after" chores since they are fluid and based on the previous date. -| Service Data Attribute | Optional | Description | +| Service Data Attribute | Type | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------- | -| `entity_id` | No | The entity ID of the chore or chores to offset the due date of. | -| `offset` | No | The number of days to offset the due date by. This can be positive or negative. | -| `date` | Yes | The date of the chore to offset, or the next due date if blank. | +| `entity_id` | Required | The entity ID of the chore or chores to offset the due date of. | +| `offset` | Required | The number of days to offset the due date by. This can be positive or negative. | +| `date` | Optional | The date of the chore to offset, or the next due date if blank. | ### chore_helper.remove_date This service can be called to remove a chore date (e.g. skip a chore). This removes the next due date if no date is passed. If a date is passed, it will remove the due date that matches the date passed. Even if no due date currently matches, the removal will persist so that if a due date is added that matches the date passed, it will be removed as well. -| Service Data Attribute | Optional | Description | +| Service Data Attribute | Type | Description | | ---------------------- | -------- | --------------------------------------------------------------- | -| `entity_id` | No | The entity ID of the chore or chores to add a due date to. | -| `date` | Yes | The date of the chore to remove, or the next due date if blank. | +| `entity_id` | Required | The entity ID of the chore or chores to add a due date to. | +| `date` | Optional | The date of the chore to remove, or the next due date if blank. | ### chore_helper.update_state From 1ade588e418233f6970112e785d57ff692c48baa Mon Sep 17 00:00:00 2001 From: Sven Koch <39488412+SVNKoch@users.noreply.github.com> Date: Sun, 22 Sep 2024 15:48:43 +0200 Subject: [PATCH 2/3] Readme: left align all tables Signed-off-by: Sven Koch <39488412+SVNKoch@users.noreply.github.com> --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6be3e23..b27302a 100755 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ know how it could be improved! **This component will set up the following platforms.** | Platform | Description | -| ---------- | ------------------------------------- | +| :--------- | :------------------------------------ | | `sensor` | Contains the state for a single chore | | `calendar` | A Chore calendar for easy tracking | @@ -103,7 +103,7 @@ The other attributes are the next due date, the last completed date, whether the This service can be called to mark a chore as completed. It will automatically schedule the next due date for the chore, and adjust future due dates if necessary (e.g. when scheduling "after" chores). | Service Data Attribute | Type | Description | -| ---------------------- | -------- | --------------------------------------------------------------------------------------- | +| :--------------------- | :------- | :-------------------------------------------------------------------------------------- | | `entity_id` | Required | The entity ID of the chore or chores to complete. | | `last_completed` | Optional | The date the chore was last completed. If not specified, the current date will be used. | @@ -112,7 +112,7 @@ This service can be called to mark a chore as completed. It will automatically s This service can be called to add a due date to a chore manually. This is useful for custom chores that don't have any due dates scheduled automatically. | Service Data Attribute | Type | Description | -| ---------------------- | -------- | ---------------------------------------------------------- | +| :--------------------- | :------- | :--------------------------------------------------------- | | `entity_id` | Required | The entity ID of the chore or chores to add a due date to. | | `date` | Required | The date the chore is due. | @@ -121,7 +121,7 @@ This service can be called to add a due date to a chore manually. This is useful This service can be called to offset the next due date of a chore. This will only affect the next due date for "every" chores, but will affect all future due dates for "after" chores since they are fluid and based on the previous date. | Service Data Attribute | Type | Description | -| ---------------------- | -------- | ------------------------------------------------------------------------------- | +| :--------------------- | :------- | :------------------------------------------------------------------------------ | | `entity_id` | Required | The entity ID of the chore or chores to offset the due date of. | | `offset` | Required | The number of days to offset the due date by. This can be positive or negative. | | `date` | Optional | The date of the chore to offset, or the next due date if blank. | @@ -131,7 +131,7 @@ This service can be called to offset the next due date of a chore. This will onl This service can be called to remove a chore date (e.g. skip a chore). This removes the next due date if no date is passed. If a date is passed, it will remove the due date that matches the date passed. Even if no due date currently matches, the removal will persist so that if a due date is added that matches the date passed, it will be removed as well. | Service Data Attribute | Type | Description | -| ---------------------- | -------- | --------------------------------------------------------------- | +| :--------------------- | :------- | :-------------------------------------------------------------- | | `entity_id` | Required | The entity ID of the chore or chores to add a due date to. | | `date` | Optional | The date of the chore to remove, or the next due date if blank. | From 5ca1b01a6d3d9c924b09092cd0d3df0bf1196f9c Mon Sep 17 00:00:00 2001 From: Sven Koch <39488412+SVNKoch@users.noreply.github.com> Date: Sun, 22 Sep 2024 15:52:08 +0200 Subject: [PATCH 3/3] Readme: add parameter table for update_state Signed-off-by: Sven Koch <39488412+SVNKoch@users.noreply.github.com> --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index b27302a..965fe31 100755 --- a/README.md +++ b/README.md @@ -139,6 +139,10 @@ This service can be called to remove a chore date (e.g. skip a chore). This remo This service can be called to update the state of a chore. This is mainly useful for custom chores that don't automatically update themselves. +| Service Data Attribute | Type | Description | +| :--------------------- | :------- | :------------------------------------------------------------------------- | +| `entity_id` | Required | The entity ID of the chore or chores to update their state and attributes. | + ## Contributions are welcome! If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)