Skip to content

Commit

Permalink
Small documentation comment
Browse files Browse the repository at this point in the history
  • Loading branch information
daveaglick committed Dec 29, 2022
1 parent c9f725c commit 80d048e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/core/Statiq.Common/Meta/Keys.cs
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,14 @@ public static class Keys
/// <summary>
/// Allows you to set an alternate date/time that the engine will use as the current date/time.
/// </summary>
/// <remarks>
/// Note that this can result in unexpected behavior when using write times or other variable
/// date/time values for documents (as Statiq Web does). For example, if you set this value
/// to a date in the past, any time you edit a file, the write time for that file will be set
/// to the current time and it will no longer be considered before your set
/// <see cref="CurrentDateTime"/> value. When using this setting, you should also set explicit
/// dates for all content where applicable (such as "Published" in Statiq Web).
/// </remarks>
/// <type cref="DateTime" />
public const string CurrentDateTime = nameof(CurrentDateTime);

Expand Down

0 comments on commit 80d048e

Please sign in to comment.