Skip to content

Commit 41a3aa4

Browse files
committed
Add changelog in rustdoc
1 parent de00631 commit 41a3aa4

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

src/lib.rs

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//! Nutmeg draws terminal progress bars whose appearance is completely controlled
44
//! by the application.
55
//!
6-
//! ## Concept
6+
//! # Concept
77
//!
88
//! By contrast to other Rust progress-bar libraries, Nutmeg has no built-in
99
//! concept of what the progress bar or indicator should look like: this is
@@ -41,7 +41,7 @@
4141
//!
4242
//! Errors in writing to the terminal cause a panic.
4343
//!
44-
//! ## Example
44+
//! # Example
4545
//!
4646
//! ```
4747
//! use std::io::Write;
@@ -86,7 +86,7 @@
8686
//!
8787
//! See the `examples/` directory for more.
8888
//!
89-
//! ## Potential future features
89+
//! # Potential future features
9090
//!
9191
//! * Draw updates from a background thread, so that it will keep ticking even
9292
//! if not actively updated, and to better handle applications that send a
@@ -99,6 +99,12 @@
9999
//! * Better detection of when to draw progress or not. Possibly look at
100100
//! `TERM=dumb`; possibly hook in to a standard Rust mechanism e.g.
101101
//! <https://github.com/rust-cli/team/issues/15#issuecomment-891350115>.
102+
//!
103+
//! # Changelog
104+
//!
105+
//! ## 0.0.0
106+
//!
107+
//! * First release.
102108
103109
#![warn(missing_docs)]
104110

0 commit comments

Comments
 (0)