Skip to content

Commit

Permalink
updated the wording a little more to make the articles consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
pjkaufman committed Oct 25, 2024
1 parent 13c57f6 commit 97433b9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/docs/settings/yaml-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -1082,7 +1082,7 @@ Keep track of the date the file was last edited in the YAML front matter. Gets d
| `Date Created Source of Truth` | Specifies where to get the date created value from if it is already present in the frontmatter. | `file system`: The file system date created value is used to set the value of date created in the frontmatter<br/><br/>`frontmatter`: When a value is present in the frontmatter for date created, this value is used as the value for the date created | `file system` |
| `Date Modified` | Insert the date the file was last modified | N/A | `true` |
| `Date Modified Key` | Which YAML key to use for modification date | N/A | `date modified` |
| `Date Modified Source of Truth` | Specifies what way should be used to determine when the date modified should be updated if it is already present in the frontmatter. | `file system`: The file system date modified value is used to set the value of date modified in the frontmatter<br/><br/>`user or Linter edits`: When a value is present in the frontmatter for date modified, date modified is kept as is unless the Linter makes a change to the note or the user edits a note with the setting `Update YAML Timestamp on File Contents Update` set to something other than `Never`. | `file system` |
| `Date Modified Source of Truth` | Specifies what way should be used to determine when the date modified should be updated if it is already present in the frontmatter. | `file system`: The file system date modified value is used to set the value of date modified in the frontmatter<br/><br/>`user or Linter edits`: When a value is present in the frontmatter for date modified, date modified is kept as is unless the Linter makes a change to a note or the user edits a note with the setting `Update YAML Timestamp on File Contents Update` set to something other than `Never`. | `file system` |
| `Format` | Moment date format to use (see <a href="https://momentjscom.readthedocs.io/en/latest/moment/04-displaying/01-format/">Moment format options</a>) | N/A | `dddd, MMMM Do YYYY, h:mm:ss a` |
| `Convert Local Time to UTC` | Uses UTC equivalent for saved dates instead of local time | N/A | false |
| `Update YAML Timestamp on File Contents Update` | When the currently active note is modified, <code>YAML Timestamp</code> is run on the note. This should update the modified note timestamp if it is more than 5 seconds off from the current value. | `never`: never<br/><br/>`after 5 seconds`: after 5 seconds<br/><br/>`after 10 seconds`: after 10 seconds<br/><br/>`after 15 seconds`: after 15 seconds<br/><br/>`after 30 seconds`: after 30 seconds<br/><br/>`after 1 minute`: after 1 minute | `never` |
Expand Down
2 changes: 1 addition & 1 deletion src/rules/yaml-timestamp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ export default class YamlTimestamp extends RuleBuilder<YamlTimestampOptions> {
},
{
value: 'user or Linter edits',
description: 'When a value is present in the frontmatter for date modified, date modified is kept as is unless the Linter makes a change to the note or the user edits a note with the setting `{NAME}` set to something other than `{NEVER}`.'.replace('{NAME}', getTextInLanguage('rules.yaml-timestamp.update-on-file-contents-updated.name')).replace('{NEVER}', getTextInLanguage('enums.never')),
description: 'When a value is present in the frontmatter for date modified, date modified is kept as is unless the Linter makes a change to a note or the user edits a note with the setting `{NAME}` set to something other than `{NEVER}`.'.replace('{NAME}', getTextInLanguage('rules.yaml-timestamp.update-on-file-contents-updated.name')).replace('{NEVER}', getTextInLanguage('enums.never')),
},
],
}),
Expand Down

0 comments on commit 97433b9

Please sign in to comment.