Skip to content

docs(stackable-telemetry): Add #![warn(missing_docs)] #944

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 18, 2025

Conversation

Techassi
Copy link
Member

Part of stackabletech/issues#639

This PR adds #![warn(missing_docs)] to the crate root of stackable-telemetry to ensure every public item is documented. It also adds any missing doc comments and also improves a bunch of them.

@Techassi Techassi marked this pull request as ready for review February 4, 2025 15:51
@siegfriedweber siegfriedweber requested review from siegfriedweber and removed request for NickLarsenNZ February 18, 2025 08:28
Techassi and others added 2 commits February 18, 2025 12:13
Co-authored-by: Siegfried Weber <mail@siegfriedweber.net>
Co-authored-by: Siegfried Weber <mail@siegfriedweber.net>
Copy link
Member

@siegfriedweber siegfriedweber left a comment

Choose a reason for hiding this comment

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

LGTM

@Techassi Techassi added this pull request to the merge queue Feb 18, 2025
Merged via the queue into main with commit 6636d94 Feb 18, 2025
10 checks passed
@Techassi Techassi deleted the docs/add-missing-doc-comments branch February 18, 2025 14:30
@lfrancke lfrancke moved this from Development: Done to Done in Stackable Engineering Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants