Skip to content

Conversation

@mjameswh
Copy link
Contributor

@mjameswh mjameswh commented Jan 15, 2026

What was changed

  • Revamped typedocs for ActivityCancellationTypes and ChildWorkflowCancellationTypes.
  • Uniformize to "Cancellation" and "Cancelled" (with two Ls) everywhere that can be changed without breaking. Note that we unfortunately have some legacy inconsistencies in our protobuf APIs, so we can't fix 100% of cases.
  • Uniformize coding pattern for the enum-as-const-object-of-strings idiom
    (typedoc should be on the const object, not on the type directive, and the type
    should come after the const object definition).
  • Fix some broken tsdoc @default tags (it can't be followed by {@link ...}).

@mjameswh mjameswh requested a review from a team as a code owner January 15, 2026 22:15
@mjameswh mjameswh changed the title doc: Revisit doc on [Activity|ChildWorkflow]CancellationTypes + other minor lints doc: Revisit doc on [Activity|ChildWorkflow]CancellationTypes + other minor lints Jan 15, 2026
Copy link
Member

@chris-olszewski chris-olszewski left a comment

Choose a reason for hiding this comment

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

I've been in incidents caused by canceled vs cancelled

@mjameswh mjameswh merged commit ae4cb9a into main Jan 16, 2026
51 of 52 checks passed
@mjameswh mjameswh deleted the cancellation-types-docs branch January 16, 2026 17:01
Sign up for free to 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.

3 participants