Skip to content

Commit fd9f25c

Browse files
chore: Fix documentation links in backend-specific session crates
1 parent 778180b commit fd9f25c

File tree

5 files changed

+58
-138
lines changed

5 files changed

+58
-138
lines changed

libs/.cargo/config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
[alias]
2-
api_ref = "doc --no-deps -p pavex -p pavex_session -p pavex_session_sqlx -p pavex_session_memory_store -p pavex_cli_client"
2+
api_ref = "doc --all-features --no-deps -p pavex -p pavex_session -p pavex_session_sqlx -p pavex_session_memory_store -p pavex_cli_client"

libs/Cargo.lock

Lines changed: 32 additions & 101 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

libs/pavex_session/src/kit.rs

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,11 @@ use pavex::{f, t};
2323
/// use pavex_session::SessionKit;
2424
///
2525
/// let mut bp = Blueprint::new();
26-
/// SessionKit::new()
27-
/// .with_default_config()
28-
/// .register(&mut bp);
26+
/// SessionKit::new().register(&mut bp);
2927
/// // Sessions are built on top of cookies,
3028
/// // so you need to set those up too.
3129
/// // Order is important here!
32-
/// CookieKit::new()
33-
/// .with_default_processor_config()
34-
/// .register(&mut bp);
30+
/// CookieKit::new().register(&mut bp);
3531
/// ```
3632
pub struct SessionKit {
3733
/// The constructor for [`Session`].

libs/pavex_session_memory_store/src/lib.rs

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -249,36 +249,32 @@ mod kit {
249249
/// use pavex_session_memory_store::InMemorySessionKit;
250250
///
251251
/// let mut bp = Blueprint::new();
252-
/// InMemorySessionKit::new()
253-
/// .with_default_config()
254-
/// .register(&mut bp);
252+
/// InMemorySessionKit::new().register(&mut bp);
255253
/// // Sessions are built on top of cookies,
256254
/// // so you need to set those up too.
257255
/// // Order is important here!
258-
/// CookieKit::new()
259-
/// .with_default_processor_config()
260-
/// .register(&mut bp);
256+
/// CookieKit::new().register(&mut bp);
261257
/// ```
262258
pub struct InMemorySessionKit {
263259
/// The constructor for [`Session`].
264260
///
265261
/// By default, it uses [`Session::new`].
266262
///
267-
/// [`Session`]: pavex_session::Session
268-
/// [`Session::new`]: pavex_session::Session::new
263+
/// [`Session`]: https://pavex.dev/docs/api_reference/pavex_session/struct.Session
264+
/// [`Session::new`]: https://pavex.dev/docs/api_reference/pavex_session/struct.Session#method.new
269265
pub session: Option<Constructor>,
270266
/// The constructor for [`IncomingSession`].
271267
///
272268
/// By default, it uses [`IncomingSession::extract`].
273269
///
274-
/// [`IncomingSession`]: pavex_session::IncomingSession
275-
/// [`IncomingSession::extract`]: pavex_session::IncomingSession::extract
270+
/// [`IncomingSession`]: https://pavex.dev/docs/api_reference/pavex_session/struct.IncomingSession
271+
/// [`IncomingSession::extract`]: https://pavex.dev/docs/api_reference/pavex_session/struct.IncomingSession#method.extract
276272
pub incoming_session: Option<Constructor>,
277273
/// Register [`SessionConfig`] as a configuration type.
278274
///
279275
/// By default, it uses `session` as configuration key.
280276
///
281-
/// [`SessionConfig`]: pavex_session::SessionConfig
277+
/// [`SessionConfig`]: https://pavex.dev/docs/api_reference/pavex_session/struct.SessionConfig
282278
pub session_config: Option<ConfigType>,
283279
/// The constructor for [`InMemorySessionStore`].
284280
///
@@ -292,8 +288,8 @@ mod kit {
292288
/// By default, it uses [`SessionStore::new`] with [`InMemorySessionStore`]
293289
/// as its underlying storage backend.
294290
///
295-
/// [`SessionStore`]: pavex_session::SessionStore
296-
/// [`SessionStore::new`]: pavex_session::SessionStore::new
291+
/// [`SessionStore`]: https://pavex.dev/docs/api_reference/pavex_session/struct.SessionStore
292+
/// [`SessionStore::new`]: https://pavex.dev/docs/api_reference/pavex_session/struct.SessionStore#method.new
297293
/// [`InMemorySessionStore`]: crate::InMemorySessionStore
298294
pub session_store: Option<Constructor>,
299295
/// A post-processing middleware to sync the session state with the session store
@@ -302,8 +298,8 @@ mod kit {
302298
/// By default, it's set to [`finalize_session`].
303299
/// The error is handled by [`FinalizeError::into_response`].
304300
///
305-
/// [`FinalizeError::into_response`]: pavex_session::errors::FinalizeError::into_response
306-
/// [`finalize_session`]: pavex_session::finalize_session
301+
/// [`FinalizeError::into_response`]: https://pavex.dev/docs/api_reference/pavex_session/errors/enum.FinalizeError#method.into_response
302+
/// [`finalize_session`]: https://pavex.dev/docs/api_reference/pavex_session/fn.finalize_session
307303
pub session_finalizer: Option<PostProcessingMiddleware>,
308304
}
309305

0 commit comments

Comments
 (0)