Skip to content

Improve docstrings and inline comments in example scripts #4040

@DhineshPonnarasan

Description

@DhineshPonnarasan

Description

Some example scripts in the examples/ directory have minimal or unclear docstrings and inline comments.

Improving these would help new users better understand how the scripts work and how to use them effectively.

Scope of Improvement

  • Add or improve docstrings for functions and classes
  • Clarify arguments and return values
  • Add inline comments for non-obvious logic

Contribution

I’d like to work on this and submit a PR with improvements.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions