Skip to content

Commit 4f98a7e

Browse files
committed
docs(README): update docs to show changes
1 parent 15c704b commit 4f98a7e

File tree

5 files changed

+23
-21
lines changed

5 files changed

+23
-21
lines changed

CHANGELOG.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,6 @@
66

77
- **cli.yml:** Can provide a custom template for html documentation ([05936821](https://github.com/dustinknopoff/bashdoc/commit/059368217d8f155662a1ee3e156d0e0e373c2c03), breaks [#](https://github.com/dustinknopoff/bashdoc/issues/))
88

9-
#### Features
10-
11-
- **Delimiters:** override global .bashdocrc within a directory ([45517f6d](https://github.com/dustinknopoff/bashdoc/commit/45517f6d7b2be21d3510c4c008cc63ea99653c12))
12-
- **Extracted:** Parsing of bashdocs from text now includes the line number of the function extract ([0ce89d6e](https://github.com/dustinknopoff/bashdoc/commit/0ce89d6e65efd4852b79aecf89a37d746922f4bf))
13-
- **Windows:** support for windows filepaths ([fec2de62](https://github.com/dustinknopoff/bashdoc/commit/fec2de6235b82c18ebaf839aa0e736196850ab40))
14-
- **cli.yml:** Can provide a custom template for html documentation ([05936821](https://github.com/dustinknopoff/bashdoc/commit/059368217d8f155662a1ee3e156d0e0e373c2c03), breaks [#](https://github.com/dustinknopoff/bashdoc/issues/))
15-
- **docs.rs:** Upgrade to 2018 edition, move to nom for parsing ([e7b0541b](https://github.com/dustinknopoff/bashdoc/commit/e7b0541b5fe26db23198e15100916f0d59fbeeae))
16-
- **output HTML:**
17-
- Basic example of outputting html documentation of a bashdoc call ([0155a3e8](https://github.com/dustinknopoff/bashdoc/commit/0155a3e84058b2378b8c0dfc7b37e62c2a3bda7e))
18-
- Extremely bare example of creating html documentation from a bashdoc call ([030645ef](https://github.com/dustinknopoff/bashdoc/commit/030645ef8fc1c2d66e4095c14146c6ac9f6ec8d7))
19-
- **script.js:**
20-
- Highlight clicked on function ([5bab275c](https://github.com/dustinknopoff/bashdoc/commit/5bab275cf8fb291934122d7bc9520733530a775b))
21-
- Highlight clicked on function ([b8d25409](https://github.com/dustinknopoff/bashdoc/commit/b8d25409d328ad1d282ba45c58b3a19f0630166b))
22-
23-
#### Performance
24-
25-
- **generate_doc_file:** Parallelize Doc generation ([984e546e](https://github.com/dustinknopoff/bashdoc/commit/984e546e19aed5aec4ad91d6cf4b506b03c31d42))
26-
279
#### Bug Fixes
2810

2911
- **0.4.0:** ([31d2454b](https://github.com/dustinknopoff/bashdoc/commit/31d2454bcb44a074c2b22e1c58ff38a64f78a830))
@@ -35,6 +17,7 @@
3517
- Metadata for publishing added ([8fda35d6](https://github.com/dustinknopoff/bashdoc/commit/8fda35d68637380499b8aaf515570bc7e41cafc3))
3618
- Remove email ([29d67053](https://github.com/dustinknopoff/bashdoc/commit/29d67053bb62e31458a9be9635b6fdb078f52639))
3719
- **Clippy:** Allow Cyclomatic Complexity on nom parser ([6ce68ec9](https://github.com/dustinknopoff/bashdoc/commit/6ce68ec90e0525977b716ce579a24d64b491ca33))
20+
- **Delimiters:** descriptors can split on things other than whitespace ([15c704b9](https://github.com/dustinknopoff/bashdoc/commit/15c704b97754314f1577a1d7f1630bd2bfa2174e))
3821
- **Docs:** Better md formatting ([8d4df95b](https://github.com/dustinknopoff/bashdoc/commit/8d4df95b3759f9ec9472c7322f3229f297fae22f))
3922
- **README:**
4023
- include cargo install instructions ([5c504667](https://github.com/dustinknopoff/bashdoc/commit/5c5046676c2842a7dbcaedc80f47c1b1a365039c))
@@ -57,3 +40,21 @@
5740
- **html:** remove example html to stop inflation of html in repo ([e9965c58](https://github.com/dustinknopoff/bashdoc/commit/e9965c58df218db21b6fe04d05748a10d132d334))
5841
- **screenshot:** ([87d31b24](https://github.com/dustinknopoff/bashdoc/commit/87d31b2469614f92ca1a42fa81d08d590692a610))
5942
- **static:** remove unnecessary CSS files ([38b6f064](https://github.com/dustinknopoff/bashdoc/commit/38b6f06476e8ecaba05c497cda3022bec6fa8d5d))
43+
44+
#### Performance
45+
46+
- **generate_doc_file:** Parallelize Doc generation ([984e546e](https://github.com/dustinknopoff/bashdoc/commit/984e546e19aed5aec4ad91d6cf4b506b03c31d42))
47+
48+
#### Features
49+
50+
- **Delimiters:** override global .bashdocrc within a directory ([45517f6d](https://github.com/dustinknopoff/bashdoc/commit/45517f6d7b2be21d3510c4c008cc63ea99653c12))
51+
- **Extracted:** Parsing of bashdocs from text now includes the line number of the function extract ([0ce89d6e](https://github.com/dustinknopoff/bashdoc/commit/0ce89d6e65efd4852b79aecf89a37d746922f4bf))
52+
- **Windows:** support for windows filepaths ([fec2de62](https://github.com/dustinknopoff/bashdoc/commit/fec2de6235b82c18ebaf839aa0e736196850ab40))
53+
- **cli.yml:** Can provide a custom template for html documentation ([05936821](https://github.com/dustinknopoff/bashdoc/commit/059368217d8f155662a1ee3e156d0e0e373c2c03), breaks [#](https://github.com/dustinknopoff/bashdoc/issues/))
54+
- **docs.rs:** Upgrade to 2018 edition, move to nom for parsing ([e7b0541b](https://github.com/dustinknopoff/bashdoc/commit/e7b0541b5fe26db23198e15100916f0d59fbeeae))
55+
- **output HTML:**
56+
- Basic example of outputting html documentation of a bashdoc call ([0155a3e8](https://github.com/dustinknopoff/bashdoc/commit/0155a3e84058b2378b8c0dfc7b37e62c2a3bda7e))
57+
- Extremely bare example of creating html documentation from a bashdoc call ([030645ef](https://github.com/dustinknopoff/bashdoc/commit/030645ef8fc1c2d66e4095c14146c6ac9f6ec8d7))
58+
- **script.js:**
59+
- Highlight clicked on function ([5bab275c](https://github.com/dustinknopoff/bashdoc/commit/5bab275cf8fb291934122d7bc9520733530a775b))
60+
- Highlight clicked on function ([b8d25409](https://github.com/dustinknopoff/bashdoc/commit/b8d25409d328ad1d282ba45c58b3a19f0630166b))

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "bashdoc"
3-
version = "0.4.11"
3+
version = "0.4.12"
44
authors = ["Dustin Knopoff <dustinknopoff@gmail.com>"]
55
description = """
66
A tool for generating documentation/help menu for user defined bash functions.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,5 +107,6 @@ See the [changelog](https://github.com/dustinknopoff/bashdoc/blob/master/CHANGEL
107107
- v0.4.9 - Improved error path handling
108108
- v0.4.10 - Support for windows file paths again
109109
- v0.4.11 - support for overriding global `.bashdocrc` within a directory.
110+
- v0.4.12 - descriptors can be split on ':' or whitespace
110111

111112
License: MIT

cli.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
about: 'Creates a "javadoc" like structure for bash. See github repo github.com/dustinknopoff/bashdoc for information on formatting.'
22
name: bashdoc
3-
version: "0.4.11"
3+
version: "0.4.12"
44
args:
55
- color:
66
help: "toggles color"

src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@
6666
//!
6767
//!```bash
6868
//!bashdoc 0.4.10
69-
//!Dustin Knopoff <dustinknopoff@gmail.com>
7069
//!Creates a "javadoc" like structure for bash. See github repo github.com/dustinknopoff/bashdoc for information on formatting.
7170
//!
7271
//!USAGE:
@@ -106,6 +105,7 @@
106105
//!- v0.4.9 - Improved error path handling
107106
//!- v0.4.10 - Support for windows file paths again
108107
//! - v0.4.11 - support for overriding global `.bashdocrc` within a directory.
108+
//! - v0.4.12 - descriptors can be split on ':' or whitespace
109109
mod docs;
110110
use crate::docs::runners::*;
111111
use clap::{load_yaml, App};

0 commit comments

Comments
 (0)