Support help for plugins in sasview
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 70/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Review linked issue #765 for SasView help system markup requirements, then locate existing model docstrings in the sasmodels package to assess current reStructuredText usage. Update docstring conventions to use markup compatible with the SasView help renderer, then verify changes display correctly in the help system.
Written by the indexing model from the issue text.
Description
Modify docstring conventions for models so that they can be rendered in the SasView help system.
The current docstring markup is done with reStructuredText which only supports full document build.
See #765
- Dominant language
- Python
- Stars
- 23
- Forks
- 32
- Avg merge
- 7d 20h
- Merged PRs (30d)
- 2
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SasView/sasmodels
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Documentation SasModels Infrastructure
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
SasModels Infrastructure
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 3/5 Half a day Newbie friendliness 35/100
All issues in SasView/sasmodels
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
WingedGuardian/GENesis-AGI#3375 ·
Maintainers usually reply within 1 day
-
curriculum documentation quality
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
githubnext/gh-aw-workshop#4601 ·
Maintainers usually reply within 1 day
-
approved Good First Issue scope: docs
Difficulty 1/5 Under an hour Newbie friendliness 85/100
hiero-ledger/hiero-sdk-python#2730 · 3 comments ·
Maintainers usually reply within 1 day