Making net feature flag show in documentation for net::UdpSocket
#6938
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
jofas
commented
Oct 26, 2024
Comment on lines
+49
to
50
| #[doc(inline)] | ||
| pub use udp::UdpSocket; |
There was a problem hiding this comment.
Alternatively one could wrap the re-export here in another cfg_net!, but I thought #[doc(inline)] would be less confusing:
Suggested change
| #[doc(inline)] | |
| pub use udp::UdpSocket; | |
| cfg_net! { | |
| pub use udp::UdpSocket; | |
| } |
Although, given that the net::udp module is already wrapped in a cfg_net! here, I believe we could also replace this cfg_net! (whose sole purpose is for the feature gate to show up in the docs in the first place, I reckon) with the one on the re-export I suggested above, in which case this would be the more straight-forward solution IMO.
jofas
changed the title
net feature flag show in documentation for net::UdpSocket
kodiakhq bot
pushed a commit
to pdylanross/fatigue
that referenced
this pull request
Nov 8, 2024
Bumps tokio from 1.41.0 to 1.41.1. Release notes Sourced from tokio's releases. Tokio v1.41.1 1.41.1 (Nov 7th, 2024) Fixed metrics: fix bug with wrong number of buckets for the histogram (#6957) net: display net requirement for net::UdpSocket in docs (#6938) net: fix typo in TcpStream internal comment (#6944) #6957: tokio-rs/tokio#6957 #6938: tokio-rs/tokio#6938 #6944: tokio-rs/tokio#6944 Commits bb7ca75 chore: prepare Tokio v1.41.1 (#6959) 4a34b77 metrics: fix bug with wrong number of buckets for the histogram (#6957) 8897885 docs: fix mismatched backticks in CONTRIBUTING.md (#6951) 0dbdd19 ci: update cargo-check-external-types to 0.1.13 (#6949) 94e55c0 net: fix typo in TcpStream internal comment (#6944) 4468f27 metrics: fixed flaky worker_steal_count test (#6932) 070a825 metrics: removed race condition from global_queue_depth_multi_thread test (#6... 946401c net: display net requirement for net::UdpSocket in docs (#6938) 0c01fd2 ci: use patched version of cargo-check-external-types to fix CI failure (#6937) ebe2416 ci: use cargo deny (#6931) See full diff in compare view Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase. Dependabot commands and options You can trigger Dependabot actions by commenting on this PR: @dependabot rebase will rebase this PR @dependabot recreate will recreate this PR, overwriting any edits that have been made to it @dependabot merge will merge this PR after your CI passes on it @dependabot squash and merge will squash and merge this PR after your CI passes on it @dependabot cancel merge will cancel a previously requested merge and block automerging @dependabot reopen will reopen this PR if it is closed @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
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.
Fixes #6935. I nudged rustdoc to show the
netfeature on the re-export bycfg(inline)ing the documentation ofUdpSocket. This works becausenet::udp::UdpSocketis already wrapped in acfg_net!, which is seemingly stripped by rustdoc from the re-exported item.Here are screenshots from my branch built with