Skip to content

Replace TBD XML doc placeholders in Akka.Event - #8118

Merged
Aaronontheweb merged 6 commits into
akkadotnet:devfrom
MattKotsenas:docs/event
Aug 30, 2026
Merged

Replace TBD XML doc placeholders in Akka.Event#8118
Aaronontheweb merged 6 commits into
akkadotnet:devfrom
MattKotsenas:docs/event

Conversation

@MattKotsenas

Copy link
Copy Markdown
Contributor

Changes

Replace TBD XML doc placeholders in the Akka.Event namespace with useful documentation. Three files updated:

  • EventStream.cs - documented the system parameter on StartUnsubscriber
  • LoggerMailbox.cs - used <inheritdoc/> for LoggerMailboxType constructor and Create (base class already has good docs); wrote new docs for the LoggerMailbox constructor describing the unbounded queue and StandardOutLogger drain behavior
  • TraceLogger.cs - used <inheritdoc/> for OnReceive since UntypedActor already documents it

Partial fix for #3435.

Checklist

@Aaronontheweb
Aaronontheweb enabled auto-merge (squash) April 13, 2026 19:32

@Aaronontheweb Aaronontheweb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).

@Aaronontheweb
Aaronontheweb disabled auto-merge April 23, 2026 20:41
@Aaronontheweb Aaronontheweb added this to the 1.5.70 milestone Jun 15, 2026
@Aaronontheweb Aaronontheweb modified the milestones: 1.5.70, 1.5.71 Jul 3, 2026
@Aaronontheweb Aaronontheweb modified the milestones: 1.5.71, 1.5.72 Aug 27, 2026
@MattKotsenas

Copy link
Copy Markdown
Contributor Author

lol, one of these days these are going to merge :)

@Aaronontheweb
Aaronontheweb enabled auto-merge (squash) August 30, 2026 18:37
@Aaronontheweb

Copy link
Copy Markdown
Member

lol @MattKotsenas sorry, I'll force merge these - been preoccupied with Artery and source generated serialization

@Aaronontheweb
Aaronontheweb merged commit d8e1eea into akkadotnet:dev Aug 30, 2026
14 of 15 checks passed
@MattKotsenas
MattKotsenas deleted the docs/event branch August 30, 2026 20:27
@MattKotsenas

Copy link
Copy Markdown
Contributor Author

Haha, no worries! In so much as they were flushing out flaky tests I was happy to contribute.

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.

2 participants