Skip to content

Commit 2aa1f6f

Browse files
authored
Fix utils crate and history docs. (#189)
* Fix `utils` crate and `history` docs. * Fix another intra-doc link
1 parent 8af93e3 commit 2aa1f6f

File tree

4 files changed

+9
-6
lines changed

4 files changed

+9
-6
lines changed

crates/console/src/macros.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,8 @@ macro_rules! info {
9090
/// Calls `console.table()`
9191
///
9292
/// Since in most cases, this takes in an object, instead of, say a string literal/variable,
93-
/// we use [`serde`](https://serde.rs) to serialize the passed data object into [`JsValue`].
93+
/// we use [`serde`](https://serde.rs) to serialize the passed data object into
94+
/// [`JsValue`][wasm_bindgen::JsValue].
9495
///
9596
/// An `IntoIterator<Item = &str>` can be passed to specify the columns.
9697
#[macro_export]

crates/history/src/listener.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
use std::fmt;
22
use std::rc::Rc;
33

4-
/// A History Listener to manage callbacks registered on a [`History`].
4+
/// A History Listener to manage callbacks registered on a [`History`][crate::History].
55
///
6-
/// This Listener has the same behaviour as the [`EventListener`] from [`gloo`]
7-
/// that the underlying callback will be unregistered when the listener is dropped.
6+
/// This Listener has the same behaviour as the [`EventListener`][gloo_events::EventListener] from
7+
/// `gloo` that the underlying callback will be unregistered when the listener is dropped.
88
#[must_use = "the listener is removed when `HistoryListener` is dropped"]
99
pub struct HistoryListener {
1010
pub(crate) _listener: Rc<dyn Fn()>,

crates/history/src/location.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ use crate::error::HistoryResult;
99

1010
/// A history location.
1111
///
12-
/// This struct provides location information at the time [`History::location`] is called.
12+
/// This struct provides location information at the time
13+
/// [`History::location`][crate::History::location] is called.
1314
#[derive(Clone, Debug)]
1415
pub struct Location {
1516
pub(crate) path: Rc<String>,

crates/utils/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,6 @@ features = [
2323
"HtmlElement",
2424
"Location",
2525
"Window",
26-
"HtmlHeadElement"
26+
"HtmlHeadElement",
27+
"Element",
2728
]

0 commit comments

Comments
 (0)