Skip to content

Version 1.0.11

Latest
Latest
Compare
Choose a tag to compare
@yoyoberenguer yoyoberenguer released this 22 May 09:40
v1.0.11
50bce5c
This commit was created on github.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

New Version 1.0.11

PygameShader is now including a comprehensive documentation in English, French, and Spanish on the project's GitHub page.
The HTML versions of the documentation are located in the following folders:

French: Sphinx/_build/html/fr
Spanish: Sphinx/_build/html/es
English (default): Sphinx/_build/html

This version introduces several renamed functions to enhance code clarity, readability, and long-term maintainability.
Alongside these structural improvements, all function docstrings have been updated with detailed explanations, providing clearer guidance on usage, parameters, and expected outputs.

While these changes improve the developer experience and codebase consistency, they also introduce breaking changes that users need to be aware of.

⚠️ Consequences of Function Renaming:

  1. Breaking Backward Compatibility

    Code that references the previous function names will no longer work, typically resulting in runtime errors (e.g., AttributeError in Python).

    Applications or tools relying on the library may crash or behave unexpectedly unless updated to use the new function names.

  2. Required Code Refactoring

    Developers must update their code to match the new naming conventions.

    This refactoring can be time-consuming, particularly in larger projects or those where the library is deeply integrated.

New Libraries Introduced:

Fire.pyx

PygameTools

RGBConvert

These libraries contain a collection of algorithms that were originally implemented within the main Shader unit. To improve organization and simplify the project structure, I have separated these algorithms into dedicated modules.

Assets 4
Loading