Fixes Markdown documentation to be consistent with the new package version - #49
Merged
Joao-Paulo-Silva merged 3 commits intoJan 28, 2026
Conversation
Joao-Paulo-Silva
added
the
documentation
Joao-Paulo-Silva
force-pushed
the
improve/update-docs
branch
from
January 27, 2026 23:37
fe2f573 to
d433a65
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates the Markdown documentation to reflect the new versions of the package, including adjustments to functions, parameters, and improvements made during the update that have not yet been documented.