Skip to content

Document PollingSystem#metrics#4334

Merged
armanbilge merged 2 commits intotypelevel:series/3.6.xfrom
antoniojimeneznieto:add/docs
Apr 3, 2025
Merged

Document PollingSystem#metrics#4334
armanbilge merged 2 commits intotypelevel:series/3.6.xfrom
antoniojimeneznieto:add/docs

Conversation

@antoniojimeneznieto
Copy link
Copy Markdown
Member

No description provided.

* @param poller
* The poller for which metrics are being retrieved.
* @return
* An instance of PollerMetrics representing the current metrics of the poller.
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.

It's subtle, but I think this description is slightly confusing. This method doesn't return the current metrics of the poller (i.e. PollerMetrics is not an immutable datatype of metrics). Instead, it returns a PollerMetrics instance that can be used to (unsafely, side-effectually) retrieve the current metrics for that poller.

Copy link
Copy Markdown
Member

@armanbilge armanbilge left a comment

Choose a reason for hiding this comment

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

thanks!

@armanbilge armanbilge changed the title Add doc to metrics() in PollingSystem Document PollingSystem#metrics Apr 3, 2025
@armanbilge armanbilge merged commit 75a1cd6 into typelevel:series/3.6.x Apr 3, 2025
34 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants