Skip to content

[FEATURE] Improve documentation in SciJo #7

@shivasankarka

Description

@shivasankarka

What & Why

Update all documentation and docstrings throughout the repository to follow the specified docstring style guide format.

Proposed Solution

# FORMAT FOR DOCSTRING (See "Mojo docstring style guide" for more information)
1. Description *
2. Parameters *
3. Args *
4. Constraints *
5. Returns *
6. Raises *
7. SEE ALSO
8. NOTES
9. REFERENCES
10. Examples *

(Items marked with * are from the "Mojo docstring style guide")

Only add the relevant topics from this list to each function docstring as appropriate; omit irrelevant sections. Ensure all documentation is consistent and clear across the project, referencing the "Mojo docstring style guide" as needed.

Extra Context

Refer to Mojo style guide

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions