Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Misleading documentation due to markdown processing #64

Closed
GREsau opened this issue Nov 26, 2024 · 0 comments · Fixed by #65
Closed

Misleading documentation due to markdown processing #64

GREsau opened this issue Nov 26, 2024 · 0 comments · Fixed by #65

Comments

@GREsau
Copy link

GREsau commented Nov 26, 2024

The doc comment for total_scheduled_count contains this:

    /// ##### Definition
    /// This metric is equal to [`total_short_delay_duration`][TaskMetrics::total_short_delay_duration]
    /// + [`total_long_delay_duration`][TaskMetrics::total_long_delay_duration].

...which looks fine, until it's rendered as markdown (https://docs.rs/tokio-metrics/0.3.1/tokio_metrics/struct.TaskMetrics.html#definition):
image

As you can see, the line beginning with a + is interpreted as a bullet point. The way this is displayed implies that total_scheduled_count is equal to total_short_delay_duration, which left me very confused!

This also affects total_scheduled_duration, total_poll_count and total_poll_duration

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant