Skip to content

Commit 85ac94b

Browse files
committed
docs(docs): Added changelog
1 parent 0593682 commit 85ac94b

File tree

4 files changed

+14
-8
lines changed

4 files changed

+14
-8
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Changelog
2+
3+
- v0.4.0 - Added to crates.io
4+
- v0.4.1/v0.4.2 - Better descriptions for crates.io
5+
- v.0.4.5 - Fix error where bashdoc would not function for users without a ~/.bashdocrc
6+
- v.0.4.6 - Improved Error handling, --html argument removed replaced with --location, --template argument added for supplying custom .hbs

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,6 @@ SUBCOMMANDS:
9090
```
9191

9292
See the [examples](https://github.com/dustinknopoff/bashdoc/tree/master/example) folder for more.
93-
93+
See the [changelog](https://github.com/dustinknopoff/bashdoc/blob/master/CHANGELOG.md) for updates
9494

9595
License: MIT

src/docs.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -195,9 +195,9 @@ fn get_strings_from_file<'a>(p: &Path, delims: Delimiters) -> Vec<Extracted<'a>>
195195
match result {
196196
Ok(r) => r.1,
197197
Err(e) => {
198-
println!("Error parsing {}", p.display());
199-
exit(1);
200-
},
198+
println!("Error parsing {}", p.display());
199+
exit(1);
200+
}
201201
}
202202
}
203203

@@ -377,9 +377,9 @@ pub fn to_html(docstrings: &[DocFile], dir: Option<&str>, template_loc: Option<&
377377
// File::create(format!("{}/{}.html", dir, dfile.filename).as_str())
378378
// .expect("File cannot be created")
379379
// };
380-
match handlebars
381-
.render_template_source_to_write(&mut template, &json, &mut output).expect("Could not generate documentation");
382-
380+
handlebars
381+
.render_template_source_to_write(&mut template, &json, &mut output)
382+
.expect("Could not generate documentation");
383383
}
384384
}
385385

src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
//!```
8989
//!
9090
//! See the [examples](https://github.com/dustinknopoff/bashdoc/tree/master/example) folder for more.
91-
//!
91+
//! See the [changelog](https://github.com/dustinknopoff/bashdoc/blob/master/CHANGELOG.md) for updates
9292
mod docs;
9393
use crate::docs::*;
9494
use clap::{load_yaml, App, ArgMatches};

0 commit comments

Comments
 (0)