cmhughes / latexindent.pl

Perl script to add indentation (leading horizontal space) to LaTeX files. It can modify line breaks before, during and after code blocks; it can perform text wrapping and paragraph line break removal. It can also perform string-based and regex-based substitutions/replacements. The script is customisable through its YAML interface.
GNU General Public License v3.0
867 stars 84 forks source link

Add an example to the documentation for algorithm's indentation #500

Closed Saltsmart closed 9 months ago

Saltsmart commented 9 months ago

what is this pull request about?

This pull request adds an example to the documentation for illustrating the support of latexindent.pl for algorithm packages, such as algorithmic and algpseudocodex

does this relate to an existing issue?

Here is the link: issue 427

does this change any existing behaviour?

no

what does this add?

This will add files documentation/demonstrations/specialAlgo.tex, documentation/demonstrations/specialAlgo-mod1.tex and documentation/demonstrations/algo.yaml to illustrate an example for algorithm environment indentation. Correspondingly, documentation/sec-default-user-local.rst and documentation/sec-default-user-local.tex are changed for online and PDF documentation.

how do I test this?

You can check the details in documentation/sec-default-user-local.rst and documentation/sec-default-user-local.tex

cmhughes commented 9 months ago

Wonderful, thank you so much! A great contribution :)