Merge pull request #58 from xeptore/patch-1

Improve documentation

README.md

@@ -28,13 +28,13 @@ fn main() {
 
 This outputs:
 
-```
+```txt
 2022-01-19T17:27:07.013874956Z WARN [logging_example] This is an example message.
 ```
 
 You can run the above example with:
 
-```bash
+```sh
 cargo run --example init
 ```
 
@@ -42,14 +42,14 @@ Coloured output and timestamps will be enabled by default. You can remove these
 features and their respective dependencies by disabling all features in your
 `Cargo.toml`.
 
-```
+```toml
 [dependencies.simple_logger]
 default-features = false
 ```
 
 To include the `timestamps` feature, but not the `colors` feature:
 
-```
+```toml
 [dependencies.simple_logger]
 default-features = false
 features = ["timestamps"]
@@ -57,7 +57,7 @@ features = ["timestamps"]
 
 To include the `colors` feature, but not the `timestamps` feature:
 
-```
+```toml
 [dependencies.simple_logger]
 default-features = false
 features = ["colors"]
@@ -65,7 +65,7 @@ features = ["colors"]
 
 To direct logging output to `stderr` use the `stderr` feature:
 
-```
+```toml
 [dependencies.simple_logger]
 features = ["stderr"]
 ```

src/lib.rs

@@ -2,7 +2,7 @@
 //!
 //! Optional features include timestamps, colored output and logging to stderr.
 //!
-//! ```
+//! ```rust
 //! simple_logger::SimpleLogger::new().env().init().unwrap();
 //!
 //! log::warn!("This is an example message.");
@@ -12,19 +12,19 @@
 //!
 //! Just initialize logging without any configuration:
 //!
-//! ```
+//! ```rust
 //! simple_logger::init().unwrap();
 //! ```
 //!
 //! Set the log level from the `RUST_LOG` environment variable:
 //!
-//! ```
+//! ```rust
 //! simple_logger::init_with_env().unwrap();
 //! ```
 //!
 //! Hardcode a default log level:
 //!
-//! ```
+//! ```rust
 //! simple_logger::init_with_level(log::Level::Warn).unwrap();
 //! ```
 
@@ -488,7 +488,7 @@ fn set_up_color_terminal() {
     }
 }
 
-/// Initialise the logger with it's default configuration.
+/// Initialise the logger with its default configuration.
 ///
 /// Log messages will not be filtered.
 /// The `RUST_LOG` environment variable is not used.
@@ -496,7 +496,7 @@ pub fn init() -> Result<(), SetLoggerError> {
     SimpleLogger::new().init()
 }
 
-/// Initialise the logger with it's default configuration.
+/// Initialise the logger with its default configuration.
 ///
 /// Log messages will not be filtered.
 /// The `RUST_LOG` environment variable is not used.