Skip to content

Commit 80d048e

Browse files
committed
Small documentation comment
1 parent c9f725c commit 80d048e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/core/Statiq.Common/Meta/Keys.cs

+8
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,14 @@ public static class Keys
9999
/// <summary>
100100
/// Allows you to set an alternate date/time that the engine will use as the current date/time.
101101
/// </summary>
102+
/// <remarks>
103+
/// Note that this can result in unexpected behavior when using write times or other variable
104+
/// date/time values for documents (as Statiq Web does). For example, if you set this value
105+
/// to a date in the past, any time you edit a file, the write time for that file will be set
106+
/// to the current time and it will no longer be considered before your set
107+
/// <see cref="CurrentDateTime"/> value. When using this setting, you should also set explicit
108+
/// dates for all content where applicable (such as "Published" in Statiq Web).
109+
/// </remarks>
102110
/// <type cref="DateTime" />
103111
public const string CurrentDateTime = nameof(CurrentDateTime);
104112

0 commit comments

Comments
 (0)