Skip to content

Commit

Permalink
Fix broken docs
Browse files Browse the repository at this point in the history
  • Loading branch information
emhane committed Jul 23, 2022
1 parent d014b94 commit c65debc
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ jobs:
- name: Get latest version of stable rust
run: rustup update stable
- name: Check rustdoc links
run: RUSTDOCFLAGS="--deny broken_intra_doc_links" cargo doc --verbose --workspace --no-deps --document-private-items
run: RUSTDOCFLAGS="--deny rustdoc::broken_intra_doc_links" cargo doc --verbose --workspace --no-deps --document-private-items
4 changes: 2 additions & 2 deletions src/advertisement/ticket.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pub const TICKET_LIMIT_DURATION: Duration = Duration::from_secs(60 * 15);

/// Max tickets that are stored for an individual node for a topic (in the configured
/// time period).
const MAX_TICKETS_NODE_TOPIC: u8 = 3;
pub const MAX_TICKETS_NODE_TOPIC: u8 = 3;

/// The time window in which tickets are accepted for any given free ad slot.
const REGISTRATION_WINDOW_IN_SECS: u64 = 10;
Expand Down Expand Up @@ -160,7 +160,7 @@ struct PendingTicket {
/// an ActiveTopic within the time limit given by ticket_limiter_duration
/// and limits it to MAX_TICKETS_PER_NODE_TOPIC times.
#[derive(Default)]
struct TicketHistory {
pub struct TicketHistory {
/// The ticket_count keeps track of how many tickets are stored for the
/// ActiveTopic.
ticket_count: HashMap<ActiveTopic, u8>,
Expand Down
4 changes: 2 additions & 2 deletions src/discv5.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use crate::{
NodeStatus, UpdateResult,
},
node_info::NodeContact,
service::{QueryKind, RegAttempts, Service, ServiceRequest, TalkRequest},
service::{ActiveTopicQueries, QueryKind, RegAttempts, Service, ServiceRequest, TalkRequest},
Discv5Config, Enr,
};
use enr::{CombinedKey, EnrError, EnrKey, NodeId};
Expand Down Expand Up @@ -540,7 +540,7 @@ impl Discv5 {

/// Looks up a given topic on other nodes that, if currently advertising the given topic, return the enrs of
/// those ads. The query keeps going through the given topic's kbuckets until a certain number (passed to
/// [`Service::ActiveTopicQueries`] upon instantiation) of results are obtained or the query times out.
/// [`ActiveTopicQueries`] upon instantiation) of results are obtained or the query times out.
pub fn topic_query_req(
&self,
topic: &'static str,
Expand Down
2 changes: 1 addition & 1 deletion src/ipmode.rs
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ mod tests {
}
}

/// Copied from the standard library. See https://github.com/rust-lang/rust/issues/27709
/// Copied from the standard library. See <https://github.com/rust-lang/rust/issues/27709>
/// The current code is behind the `ip` feature.
pub const fn to_ipv4_mapped(ip: &std::net::Ipv6Addr) -> Option<std::net::Ipv4Addr> {
match ip.octets() {
Expand Down

0 comments on commit c65debc

Please sign in to comment.