fix comments in server/db/initalizer.rs

This commit is contained in:
ayham 2021-07-17 10:45:29 +03:00
parent dbb8e0d05a
commit d0f39990b2
Signed by: ayham
GPG Key ID: EAB7F5A9DF503678
1 changed files with 3 additions and 2 deletions

View File

@ -1,13 +1,14 @@
/// Establishes a postgresql connection to the SQL database.
///
/// Creates a postgresql connection.
/// Should be used in Async contexts.
///
/// Arguments:
/// user - The name of the user to connect to the database with.
/// pass - The password of the user to connect to the database with.
///
/// Returns: ```postgres::Client``` on success, and a string containing the
/// reason of failure on error.
/// Returns: ```Result``` wrapping ```tokio_postgres::Client``` on success,
/// and ```tokio_postgres::Error``` on error.
///
/// Example:
/// ```rust