Skip to content

Changelog¤

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

1.0.0 - 2023-09-03¤

Compare with 0.4.1

It has been a long time since the last release, and the last time I worked on this project. I've updated the project with my latest template. Support for Python 2 is dropped. I took the opportunity to privatize most of the API. I'll see in a later version if there is a need to expose a main parse function or similar, to extract information from a given file.

Breaking Changes¤

  • shellman.reader.DocLine.doc_type: Public object points to a different kind of object: function -> attribute
  • shellman.reader.preprocess_stream: Public object was removed
  • shellman.reader.preprocess_lines: Public object was removed
  • shellman.reader.process_blocks: Public object was removed
  • shellman.reader.merge: Public object was removed
  • shellman.context.get_cli_context: Public object was removed
  • shellman.context.get_env_context: Public object was removed
  • shellman.context.get_file_context: Public object was removed
  • shellman.context.get_context: Public object was removed
  • shellman.context.update: Public object was removed
  • shellman.cli.get_context: Public object was removed
  • shellman.cli.update: Public object was removed
  • shellman.cli.merge: Public object was removed
  • shellman.cli.valid_file: Public object was removed
  • shellman.cli.render: Public object was removed
  • shellman.cli.write: Public object was removed
  • shellman.cli.common_ancestor: Public object was removed
  • shellman.cli.is_format_string: Public object was removed
  • shellman.cli.guess_filename: Public object was removed
  • shellman.cli.output_name_variables: Public object was removed
  • shellman.cli.get_vcs_root: Public object was removed
  • shellman.cli.main(argv): Parameter was removed
  • shellman.templates.get_builtin_path: Public object was removed
  • shellman.templates.get_env: Public object was removed
  • shellman.templates.get_custom_template: Public object was removed
  • shellman.templates.load_plugin_templates: Public object was removed
  • shellman.templates.names: Public object was removed
  • shellman.templates.parser_choices: Public object was removed
  • shellman.templates.filters.do_groffauto(escape): Parameter kind was changed: positional or keyword -> keyword-only
  • shellman.templates.filters.do_smartwrap(indentfirst): Parameter kind was changed: positional or keyword -> keyword-only
  • shellman.templates.filters.do_format(string): Parameter was added as required
  • shellman.templates.filters.do_groupby(sort): Parameter kind was changed: positional or keyword -> keyword-only

Bug Fixes¤

  • Update for Python 3 and new versions of dependencies (e16c46f by Timothée Mazzucotelli).

Code Refactoring¤

  • Rewrite tag classes as dataclasses (f1780d4 by Timothée Mazzucotelli).

0.4.1 - 2018-10-10¤

Compare with 0.4.0

Fixed¤

  • Fix body filter for Python 2 (ce7d0ef).

0.4.0 - 2018-09-28¤

Compare with 0.3.4

Added¤

  • Add context variable to avoid escaping lines starting with given values (742e023).
  • Add usagetext template (a7c20fc).

Fixed¤

  • Fix escape filter condition (f32cd43).
  • Fix python 2 unicode decode error (0040028).
  • Fix variables for output (01155fb).

Misc¤

  • Improve error messages (96ebb68).

0.3.4 - 2018-09-22¤

Compare with 0.3.3

Fixed¤

  • Fix writing UTF-8 contents to file for Python 2 (9e99b23).

Misc¤

0.3.3 - 2018-09-18¤

Compare with 0.3.2

Fixed¤

  • Fix manifest (missing setup.py) (62ccfaf).

0.3.2 - 2018-09-18¤

Compare with 0.3.1

Misc¤

  • Add logo and demo.svg to fix PyPI page (1e06662).

0.3.1 - 2018-09-18¤

Compare with 0.3.0

Misc¤

  • Reduce size of package, simplify manifest (f123b53).
  • Switch documents to markdown (f3917e9).

0.3.0 - 2018-09-17¤

Compare with 0.2.2

Added¤

  • Add credits in wikipage template (e70b7c8).
  • Add groupby_unsorted filter to improve option rendering (2e42177).
  • Add logo (f9289a0).
  • Add new reader module (ea13cfb).
  • Add option to smart_width to indent first line or not (e625afb).
  • Add vcsroot name variable (f5db3b3).

Changed¤

  • Change README.rst to README.md (4628e76).

Fixed¤

  • Fix code block (de304ee).
  • Fix credits and readme url to gitlab plugins doc (9958019).
  • Fix get context from env (f1e2296).
  • Fix usage tag (4a47431).
  • Fix wikipage template (2f5a0ad).

Removed¤

  • Remove blank line in AUTHORS (e414282).
  • Remove formatter options, enforce user behavior (48c26d0).
  • Remove MPL2.0 notices in sources (now ISC) (87e92df).
  • Remove pyup file, remove option-description subtag (implicit) (4a08fa1).

Misc¤

  • Allow failure for style and spell on travis (4a7a60f).
  • Automatically compute indent_str from indent, cast indent to int (0a09554).
  • Handle multiple file input/output, fix some templates vars, format with black (2c6672b).
  • Ignore bandit warning as irrelevant (no html templates) (4947fe5).
  • Implement context abilities (5e7c9d4).
  • Implement plugin abilities (cd4723f).
  • Implement smart_width for text format, write more templates (bb15f51).
  • Improve helptext usage display, fix smartwrap indent (11f78bf).
  • Improve manpage groff template, fix various issues (b829593).
  • Link up with argparse (12f186d).
  • Rename tag to section (5e80735).
  • Update demo script and svg (ec0c282).
  • Update docs, simplify context usage (8c6c950).
  • Use GitLab-CI instead of Travis (de662d0).

0.2.2 - 2017-05-02¤

Compare with 0.2.1

Changed¤

  • Change license from MPL 2.0 to ISC (no 'same license' condition) (868b89e).

Fixed¤

  • Fix cli main return None -> 0 (7beeecc).
  • Fix codacy badge (fe55efb).
  • Fix docs spelling (69988a2).
  • Fix installation instruction (--user does not install entry point...) (aa2037b).
  • Fix man synopsis section (d79db9a).

Misc¤

  • Begin to fix output option (f1e5488).
  • Hide sphinx warnings, travis install enchant (c216c78).
  • Use codacy instead of codecov (c024b1c).

0.2.1 - 2016-12-06¤

Compare with 0.2.0

Misc¤

  • Update README, fix help display (a131b82).

0.2.0 - 2016-12-06¤

Compare with first commit

Added¤

  • Add check feature, add tests (4916b51).
  • Add demo example (ec78d6b).
  • Add markdown format, improve python3 compatibility, add gitignore (6b8c295).
  • Add tests (4d08087).

Fixed¤

  • Fix changing release date over upstream update (11738c4).
  • Fix command line usage and tests usage combination (bcef7c9).
  • Fix dangerous warning about sys.argv as default value (effe263).

Misc¤