Skip to content

fix(generator): adjust documentation #78

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 24, 2022
Merged

fix(generator): adjust documentation #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 2 additions & 4 deletions src/Utils/ActivityIdGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,15 @@ public static class ActivityIdGenerator
// UUID epoch (October 15, 1582) and Unix epoch (January 1, 1970)
private static long UuidEpochDifference = 122192928000000000;

/// <summary>Generates an Activity ID for the given epoch timestamp and foreign ID.</summary>
/// <summary>Generates an Activity ID for the given foreign ID and epoch timestamp.</summary>
public static Guid GenerateId(string foreignId, int epoch)
{
return GenerateId(foreignId, Epoch.AddSeconds(epoch));
}

/// <summary>
/// Generates an Activity ID for the given timestamp and foreign ID.
/// <paramref name="timestamp"/> must be UTC.
/// Generates an Activity ID for the given foreign ID and timestamp.
/// </summary>
/// <exception cref="ArgumentException">Raised if the timestamp kind if not UTC.</exception>
public static Guid GenerateId(string foreignId, DateTime timestamp)
{
// The backend doesn't care about milliseconds, so we truncate the date here.
Expand Down