Skip to content

Develop docstrings for rockmag.py functions that currently lack them #53

@Swanson-Hysell

Description

@Swanson-Hysell

Issue:

Several functions in rockmag.py currently lack docstrings. To improve code readability and maintainability, we should add docstrings to all functions.

Docstring Format

Use Google-style docstrings, with the following conventions:

  • Use Parameters instead of Args
  • Include Returns with types and descriptions
  • Line length should conform to Black formatting (~88 characters)

Examples of undocumented functions

  • interactive_verwey_estimate
  • interactive_goethite_removal

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions