Skip to content

Changelog

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

The format is based on Keep a Changelog.

Unreleased

2026.1.21 - 2026-01-21

Changed

  • Switched from using mkdocs to zensical for documentation generation.

Fixed

  • Several formatting problems that broke zensical and previous mkdocs builds.

2025.7.15 - 2025-07-15

Changed

  • Guidelines: Modify the maximum CPL (Characters Per Line) from 88 to 92.
    • Aesthetics -> Characters Per Line

2025.3.7 - 2025-03-07

Changed

  • Update the wording of the guidelines and additional text.
  • Improve the format and wording of the TODO list.

2024.12.15 - 2024-12-15

Changed

  • Guidelines: Introduced another option for continuation lines for control structures.
    • Aesthetics -> Formatting Control Structures
  • Guidelines: Modify how global variables should be documented.
    • Aesthetics -> Comments -> Function Comments
  • Update the wording of the guidelines and additional text.

2024.12.4 - 2024-12-04

NOTE:

This marks a major update to the style guide. The guide has been completely rewritten and converted to "MkDocs + Material for MkDocs". However, please note I don't consider this the "final" version of this rewrite. While 99% of the guidelines are ready for use, I want to modify the wording quite a bit, as I think I need to write it in a more easy-to-understand way. Consider this release a "beta" version of the rewrite.

Changed

  • Complete rewrite of the style guide.
  • Convert standard markdown of guide to MkDocs + Material for MkDocs.

2025.3.7 - 2025-03-07

Changed

  • Updated sections:
    • Aesthetics -> Comments -> Functions
    • Aesthetics -> Comments -> Number of pound signs
    • Style -> Quoting
  • Modified code fencing format/style.
  • Update example code.

2022.7.11 - 2022-07-11

Changed

  • Updated sections:
    • Aesthetics -> Comments -> Number of pound signs
    • Style -> Quoting
    • Style -> shebang
    • Error Checking -> eval
  • Added missing periods to every comment in fenced code blocks.
  • Other small changes.

2022.2.18 - 2022-02-18

Added

  • Added a new section:
    • Aesthetics -> Single line block statements

Changed

  • Updated wording to several sections.
  • Updated Examples/example-1.md and Examples/example-2.md.

2021.6.1 - 2021-06-01

Added

  • Added new sections:
    • Aesthetics -> Comments -> Generals
    • Aesthetics -> Comments -> Functions
    • Aesthetics -> Comments -> Block of code

Changed

  • Updated Examples/example-1.md and Examples/example-2.md.
  • Modified sections:
    • Aesthetics -> Columns
    • Aesthetics -> Comments -> File formatting and commenting
    • Style -> Variable Declaration

Fixed

  • Wording and incorrectly spelt words.

2021.5.2 - 2021-05-02

Added

  • New example page (Examples/example-2.md)

Changed

  • Updated Examples/example-1.md
  • Modified sections:
    • Aesthetics -> Spacing
    • Aesthetics -> Comments
    • Aesthetics -> Comments -> File formatting and commenting
      • Previously refered to as Commenting/File Formatting

2021.3.14 - 2021-03-14

Changed

  • Modified sections:
    • Aesthetics -> Spacing
    • Aesthetics -> Comments -> Commenting/File Formatting

2020.12.1 - 2020-12-01

Changed

  • Modified sections:
    • Aesthetics -> Spacing
    • Aesthetics -> Comments -> Commenting/File Formatting

2020.11.27 - 2020-11-27

N/A