ISISNeutronMuon / ISISNeutronMuon/MDANSE

[ENHANCEMENT] Extend examples in docstrings

Open
#693 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement Testing
Dominant language
Python
Stars
29
Forks
8
Avg merge
2d 12h
Merged PRs (30d)
9

Description

**Is your feature request related to a problem? Please describe.**
Add more examples in docstrings to enable dynamic testing.

**Describe the solution you'd like**
See: Above

**Describe alternatives you've considered**
N/A

**Additional context**
N/A

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue does not identify any files, docstrings, tests, or entry points. Start by locating the docstrings intended for dynamic testing and determine which examples are missing; confirm the expected scope with maintainers before changing them. Done means the agreed docstrings contain runnable examples that support dynamic testing.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.