Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs fix: dates in Recurring Tasks examples #2601

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/Getting Started/Recurring Tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Take as an example the following task:
- [ ] take out the trash 🔁 every Sunday 📅 2021-04-25
```

If you mark the above task "done", the file will now look like this:
If you mark the above task "done" one day early on 24 April 2021, the file will now look like this:

```markdown
- [ ] take out the trash 🔁 every Sunday 📅 2021-05-02
Expand All @@ -39,8 +39,8 @@ The next Sunday after 25 April 2021 is on 2 May.
Alternatively, if you have enabled addition of [[Dates#Created date|created dates]], the file will instead now look like this, showing the date that the new task was created:

```markdown
- [ ] take out the trash 🔁 every Sunday ➕ 2023-03-10 📅 2021-05-02
- [x] take out the trash 🔁 every Sunday 📅 2021-04-25 ✅ 2023-03-10
- [ ] take out the trash 🔁 every Sunday ➕ 2021-04-24 📅 2021-05-02
- [x] take out the trash 🔁 every Sunday 📅 2021-04-25 ✅ 2021-04-24
Comment on lines -42 to +43
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the documentation of the "addition of created dates" feature, so I believe it should be consistent with the previous example (lines 33-34) that has completion marked in 2021

```

### Order of the new task
Expand All @@ -62,11 +62,11 @@ Use this setting to control where the recurring task is inserted. The default is
When you create a recurring task, you can decide whether the next occurrence should be based on the original dates or the date when you completed the task.
The default behavior results in newly created tasks having dates relative to the original task rather than "today".

For example, given that today is the 13. February 2022 and you just completed the lower task:
For example, given that today is the 13 February 2022 and you just completed the lower task:

```markdown
- [ ] sweep the floors 🔁 every week ⏳ 2021-02-13
- [x] sweep the floors 🔁 every week ⏳ 2021-02-06 ✅ 2022-02-13
- [ ] sweep the floors 🔁 every week ⏳ 2022-02-13
- [x] sweep the floors 🔁 every week ⏳ 2022-02-06 ✅ 2022-02-13
Comment on lines -68 to +69
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As noted by the surrounding text, the completion should be one week after the originally scheduled date (not one week and a year), and the scheduled date of the new task should be the same as the completed date of the previous occurrence

```

Regardless of you having missed the original scheduled date by a week,
Expand All @@ -78,7 +78,7 @@ Below is the same example as above, but this time the new task is scheduled base

```markdown
- [ ] sweep the floors 🔁 every week when done ⏳ 2022-02-20
- [x] sweep the floors 🔁 every week when done ⏳ 2021-02-06 ✅ 2022-02-13
- [x] sweep the floors 🔁 every week when done ⏳ 2022-02-06 ✅ 2022-02-13
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as previous change; here the difference of including the when done is that the next scheduled date is February 20 (one week after completed date) rather than February 13 (one week after original scheduled date), but the year should still be the same.

```

Now the newly created task is scheduled 1 week after the task was completed rather than 1 week after it was originally scheduled.
Expand Down