Document everything #126
Merged
Document everything #126
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
g2p
force-pushed
the
document-everything
branch
3 times, most recently
from
dd29f12
to
e7fdf2d
Compare
Ruben2424
reviewed
Sep 9, 2022
|
@Ruben2424, I followed your suggestions |
g2p
force-pushed
the
document-everything
branch
from
999c086
to
d3a2906
Compare
Ruben2424
approved these changes
Sep 12, 2022
seanmonstar
approved these changes
Sep 12, 2022
|
Woops, sorry, just merged a different PR that caused some conflicts here. |
@g2p changes: Run cargo fmt, rebase and fix conflicts, fix draft doctests, remove overly incomplete draft tests.
g2p
force-pushed
the
document-everything
branch
from
d3a2906
to
5f415ef
Compare
I couldn't turn on #![deny(missing_docs)] for the whole crate because the test_helpers feature exposes about 138 undocumented qpack/proto functions. Refactoring the tests to be part of the original crate would fix that. Changed the RequestEnd struct to not be public, it is an internal struct used to notify the connection of closed streams.
g2p
force-pushed
the
document-everything
branch
from
5f415ef
to
43dbdf3
Compare
Changed some citations to match published versions. Changes were editorial as far as I could tell.
g2p
force-pushed
the
document-everything
branch
from
43dbdf3
to
8a958b0
Compare
|
Rebased, then fixed some issue with an URL that broke the format duvet report expected. |
|
Thanks again <3 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an updated and rebased version of #82.
I couldn't turn on
#![deny(missing_docs)]for the whole crate because thetest_helpersfeature exposes about 138 undocumented qpack and proto functions.Refactoring the tests to be part of the original crate would fix that (and remove the need to backdoor module privacy). I added the
#[deny(missing_docs)]attribute to the rest of the modules instead.Also updated draft references to point to published RFCs.
Motivation for the pull request is that I would like a preliminary release of the crate; see #125, and #70 before that.