Skip to content

Add missing docs, package info and bugfixes - #100

Merged
Simon Porter (simonporter) merged 3 commits into
vnextfrom
siport/packageinfo
Jul 1, 2017
Merged

Add missing docs, package info and bugfixes#100
Simon Porter (simonporter) merged 3 commits into
vnextfrom
siport/packageinfo

Conversation

@simonporter

Copy link
Copy Markdown
Contributor

Add package info for creating nuget packages including documentation.
Add missing XML docs on public classes.
Fix bug with RaiseEvent calling create orchestration causing unneeded jumpstart entry.
Always set mindatetime for storage instance store, not just for emulator.

public string ExecutionId { get; set; }

/// <summary>
/// Gets or sets the match type of either statrts with or exact match for the filter

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

statrts [](start = 50, length = 7)

typo

namespace DurableTask.Core
{
/// <summary>
/// Filter for Orchestrationname and version

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

split

using System;

/// <summary>
/// Filter for Orchestration time range on a timerange type

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • State?

Comment threadsrc/DurableTask.Core/Common/Utils.cs Outdated
const int FullGzipHeaderLength = 10;

/// <summary>
/// Gets a safe maximim datetime value that accounts for timezone

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

maximum

Comment threadsrc/DurableTask.Core/Common/Utils.cs Outdated
const int FullGzipHeaderLength = 10;

/// <summary>
/// Gets a safe maximim datetime value that accounts for timezone

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

maximim [](start = 24, length = 7)

typo


/// <summary>
/// Creates a new instance of the LocalOrchestrationService with default settings
/// </summary>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Extra line

{
DateTimeUtils.SetMinDateTimeForStorageEmulator();
}
// Workaround an issue with Storage that throws exceptions for any date < 1600 so DateTime.Min cannot be used

@rajeevmvRajeev Vokkarne (rajeevmv)Jun 30, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

// Workaround an issue with Storage that throws exceptions for any date < 1600 so DateTime.Min cannot be used [](start = 11, length = 110)

Is this comment still applicable?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Yes this is specific to Azure Tables, this code was only enabled for the emulator but the newer storage SDK also needs this

@rajeevmv

Copy link
Copy Markdown
Contributor

:shipit:

Comment threadsrc/DurableTask.Core/Common/Utils.cs Outdated
}

/// <summary>
/// Writes the supplied string input to a MemoryStream, optionaly compressing the string

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nit: optionally

should probably mention that it returns the said MemoryStream

/// </summary>
public const int OrchestrationDefaultMaxConcurrentItems = 100;

// task activity dispatcher default constants

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nit: perhaps add a newline

public class OrchestrationStateInstanceFilter : OrchestrationStateQueryFilter
{
/// <summary>
/// Creates a new instance of the OrchestrationStateInstanceFilter with default settings

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nit: comment indentation here and the rest of the code doesn't match. similarly, in a few other places below

@simonporter
Simon Porter (simonporter) deleted the siport/packageinfo branch July 7, 2017 06:00
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@simonporter@rajeevmv@pugup@msftclas