Skip to content

Latest commit

 

History

History
60 lines (51 loc) · 6.12 KB

CHANGELOG.md

File metadata and controls

60 lines (51 loc) · 6.12 KB

Bashdoc (2018-12-25)

Performance

  • generate_doc_file: Parallelize Doc generation (984e546e)

Bug Fixes

  • 0.4.0: (31d2454b)
  • All: Apply clippy fixes (bca0b613)
  • Cargo.toml:
  • Clippy: Allow Cyclomatic Complexity on nom parser (6ce68ec9)
  • Delimiters: descriptors can split on things other than whitespace (15c704b9)
  • Docs: Better md formatting (8d4df95b)
  • README:
    • include cargo install instructions (5c504667)
    • code blocks should be highlighted for bash not rust (62db2ad2)
  • Support windows again: (46f6267a)
  • Watcher: Better information on watching files (fbde071d)
  • Windows: only replace ~ with home_dir if ~ in path (b192b8a0)
  • Windows support re-added: (ca69c443)
  • cargo.toml: Specify files to package (6d99b502)
  • cli: Removed requirement for --location on all calls (e93d9144)
  • cli.yml: Keep version numbers consistent (0347fd80)
  • clippy: implement clippy suggestions (4f59d771)
  • delimiters: Resolves iisue where user with no BASHDOC_CONFIG_PATH caused a panic (8738852d)
  • demo: remove old examples (dea6213a)
  • docs.rs: Remove debug printlns (50b35b08)
  • example:
  • header: Improved header looks (b8f5433c)
  • html: remove example html to stop inflation of html in repo (e9965c58)
  • screenshot: (87d31b24)
  • static: remove unnecessary CSS files (38b6f064)

Features

  • Delimiters: override global .bashdocrc within a directory (45517f6d)
  • Extracted: Parsing of bashdocs from text now includes the line number of the function extract (0ce89d6e)
  • Windows: support for windows filepaths (fec2de62)
  • cli.yml: Can provide a custom template for html documentation (05936821, breaks #)
  • docs.rs: Upgrade to 2018 edition, move to nom for parsing (e7b0541b)
  • output HTML:
    • Basic example of outputting html documentation of a bashdoc call (0155a3e8)
    • Extremely bare example of creating html documentation from a bashdoc call (030645ef)
  • script.js:
    • Highlight clicked on function (5bab275c)
    • Highlight clicked on function (b8d25409)

Breaking Changes

  • cli.yml: Can provide a custom template for html documentation (05936821, breaks #)