add a workflow to deny on docs issues + fix docs issues #1324
Conversation
This file contains hidden or 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
at least, if i've plumbed the env var correctly. i am not an expert yaml programmer.
iximeow
force-pushed
the
ixi/deny-docs-warnings
branch
from
9ac7d30 to
0b5df8b
Compare
HttpResponseError is made public at the crate root, but it requires implementers also implement HttpResponseContent. HttpResponseContent is *not* public, so implementations of HttpResponseError are constrained to only being types that are covered by blanket impls of HttpResponseContent. i personally don't need to do that, but it makes the docs funky and is probably an error. it's morally similar to a function returning a type which is not public.
iximeow
force-pushed
the
ixi/deny-docs-warnings
branch
from
efc8ed9 to
d1c5a9e
Compare
iximeow
changed the title
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.
0b5df8b adds the new workflow and fails because there are a few docs bugs
d1c5a9e fixes the docs bugs. most of it is just references to functions or types by incorrect names/paths. the one interesting one is that
HttpResponseContentis not public, butHttpResponseError, which extends it, is. so the only possible implementations ofHttpResponseErrorare ones covered by blanket impls ofHttpResponseContent. that seems like a bug, so i've added apub use HttpResponseContenthere too.the public
dropshot::HttpResponseContentthen is used in place of the privatedropshot::handler::HttpResponseContentin compile errors so that's the changes tobad_endpoint7.stderr.i'd actually noticed this because
ErrorStatusCodehas some garbled markdown. it's not exactly a docs error butcargo docwould have complained about the bare URL not being a hyperlink inside<>. that hopefully would have nudged us towards realizing there was a missing[opening the link. tools work! isn't that neat.