Skip to content

Refine docstrings and include examples in algorithms#53

Merged
Joao-Paulo-Silva merged 15 commits intoAIS-Package:developfrom
Joao-Paulo-Silva:refactor/docs-examples
Feb 16, 2026
Merged

Refine docstrings and include examples in algorithms#53
Joao-Paulo-Silva merged 15 commits intoAIS-Package:developfrom
Joao-Paulo-Silva:refactor/docs-examples

Conversation

@Joao-Paulo-Silva
Copy link
Member

@Joao-Paulo-Silva Joao-Paulo-Silva commented Feb 9, 2026

Description

This PR refines the docstrings for the package's functions and classes, standardizing them and including usage examples (doctests) to facilitate maintenance.

Changes

  • Revision of docstrings in functions and classes.
  • Inclusion of usage examples in docstrings for the main classes.

@Joao-Paulo-Silva Joao-Paulo-Silva added documentation Improvements or additions to documentation priority: low labels Feb 15, 2026
@Joao-Paulo-Silva Joao-Paulo-Silva merged commit 6ff0f2f into AIS-Package:develop Feb 16, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority: low

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant