Skip to content
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

Doc cleanup #660

Merged
merged 2 commits into from
May 1, 2024
Merged

Doc cleanup #660

merged 2 commits into from
May 1, 2024

Conversation

vlovich
Copy link
Contributor

@vlovich vlovich commented Apr 25, 2024

What does this PR do?

Cleanups the wording in timer docs to clarify something I found ambiguous + some warnings I saw running cargo doc.

Motivation

Was confused about some wording when reading timer docs.

Related issues

#654

Additional Notes

Checklist

[] I have added unit tests to the code I am submitting
[] My unit tests cover both failure and success scenarios
[] If applicable, I have discussed my architecture

@glommer
Copy link
Collaborator

glommer commented Apr 26, 2024

@vlovich there's a clippy warning here. Note that by default clippy only runs on the code, but we ask it to build everything, including code examples

@vlovich
Copy link
Contributor Author

vlovich commented Apr 26, 2024

Hmm.... very strange. cargo clippy --all-targets -- -D warnings isn't finding the issue for me locally. Same for cargo test:

cargo test check_clippy
   Compiling glommio v0.9.0 (/home/vlovich/projects/byte-harbor/glommio/glommio)
    Finished test [unoptimized + debuginfo] target(s) in 2.88s
     Running unittests src/lib.rs (target/debug/deps/glommio-7acb0688715cdf5d)

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 389 filtered out; finished in 0.00s

     Running tests/linters.rs (target/debug/deps/linters-9fd160ff283ac980)

running 1 test
    Finished dev [unoptimized + debuginfo] target(s) in 0.07s
test tests::check_clippy ... ok

If I run nightly, then I get all sorts of clippy warnings but nothing about this malformed example.

@vlovich
Copy link
Contributor Author

vlovich commented Apr 26, 2024

Ah - cargo test --doc is needed to be run.

@glommer glommer merged commit f2bdaa3 into DataDog:master May 1, 2024
5 checks passed
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