AscendingCreations / AxumSession

Axum Session Management Libraries that use Sqlx
MIT License
136 stars 28 forks source link

Documentation update needed #49

Closed WarrenWilkinson closed 1 year ago

WarrenWilkinson commented 1 year ago

The correct documentation for creating a new session store says you need this:

let session_store = SessionStore::<SessionNullPool>::new(None, config).await.unwrap();
(https://docs.rs/axum_session/latest/axum_session/struct.SessionStore.html)

But under the main page, it omits the await.unwrap() in the examples:

let session_store = SessionStore::<SessionPgPool>::new(None, session_config);
(https://docs.rs/axum_session/latest/axum_session/)

This omission gives you a cryptic error message when you try to initialize the session_store.

genusistimelord commented 1 year ago

Thank you for the catch. I did forget to update the readme examples.

genusistimelord commented 1 year ago

fixed this.