1.0.1

1.0.1 - 2024-11-25

Compare with 1.0.0

Build

• Drop support for Python 3.8 (3675ff8 by Timothée Mazzucotelli).

Bug Fixes

• Add missing rendering of functions stdin/stdout/stderr (d7fc017 by Timothée Mazzucotelli). Issue-37

1.0.0

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. In the meantime, simply instantiating
a shellman.DocFile with the path to a script is enough.

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).

Options!

This release introduces support for command line options. See usage in documentation!