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

Collector + directory doc fixes #1247

Merged
merged 4 commits into from
Jan 4, 2022
Merged

Conversation

saroh
Copy link
Contributor

@saroh saroh commented Jan 3, 2022

Just fixing a few links :)

#1232

@@ -43,7 +43,6 @@ impl RetryPolicy {
}

/// The `DirectoryLock` is an object that represents a file lock.
/// See [`LockType`](struct.LockType.html)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

DirectoryLockGuard ? It's private though.

Copy link
Collaborator

Choose a reason for hiding this comment

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

No clue what it was

@codecov-commenter
Copy link

codecov-commenter commented Jan 3, 2022

Codecov Report

Merging #1247 (f066936) into main (098eea8) will increase coverage by 0.09%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1247      +/-   ##
==========================================
+ Coverage   94.10%   94.19%   +0.09%     
==========================================
  Files         205      206       +1     
  Lines       34457    34962     +505     
==========================================
+ Hits        32426    32933     +507     
+ Misses       2031     2029       -2     
Impacted Files Coverage Δ
common/src/writer.rs 94.33% <ø> (ø)
ownedbytes/src/lib.rs 95.43% <ø> (ø)
src/collector/facet_collector.rs 98.28% <ø> (ø)
src/collector/filter_collector_wrapper.rs 84.84% <ø> (ø)
src/directory/directory.rs 94.11% <ø> (ø)
src/directory/directory_lock.rs 88.88% <ø> (ø)
src/query/term_query/term_query.rs 93.02% <0.00%> (-0.98%) ⬇️
src/fastfield/reader.rs 94.06% <0.00%> (-0.85%) ⬇️
src/postings/stacker/expull.rs 93.85% <0.00%> (-0.44%) ⬇️
src/postings/serializer.rs 98.96% <0.00%> (-0.34%) ⬇️
... and 24 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 098eea8...f066936. Read the comment docs.

Copy link
Collaborator

@fulmicoton fulmicoton left a comment

Choose a reason for hiding this comment

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

Thank you @saroh
Do you know if there is a command to check for broken links in the rustdoc?
thtat would be cool to add that to the CI

@fulmicoton fulmicoton merged commit 395303b into quickwit-oss:main Jan 4, 2022
@saroh saroh deleted the 1232-doc-misc branch January 5, 2022 18:34
@saroh
Copy link
Contributor Author

saroh commented Jan 5, 2022

Do you know if there is a command to check for broken links in the rustdoc?

@fulmicoton seems supported https://doc.rust-lang.org/rustdoc/lints.html I'll give it a go for the future packages :)

@saroh
Copy link
Contributor Author

saroh commented Jan 5, 2022

saroh@6ef8e20 should make cargo doc fail providing it's in your CI
the doc passes as is.

This was referenced Feb 18, 2022
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.

3 participants