Documentation style
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Review the documentation at https://psignifit.readthedocs.io/en/latest/ and identify inconsistent use of voice, such as “we” versus “you need to,” along with structural differences across sections. Done means the language and structure are made consistent while preserving the existing tutorial-style approach.
Written by the indexing model from the issue text.
Description
From @guillermoaguilar :
Now about the documentation, https://psignifit.readthedocs.io/en/latest/?badge=latest it is complete and 100% usable, but there were some concerns raised by @otizonaizit last time, that the language or structure might not be "standard" or at the same level of other software packages.
As I counterargument, I say that the package is very specific, it does 1 thing: psychometric function estimation. In that sense it is different from
numpyorscipy, which are much more general and thus the documentation should fit many more needs. That's why I think a 'tutorial' style is ok. Still the language
at times is mixed (e.g. "we", "you need to"), and this should be made uniform.
- Dominant language
- Python
- Stars
- 66
- Forks
- 26
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Contributor guide
No contributing guide indexed for this repository
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 wichmann-lab/python-psignifit
-
wichmann-lab/python-psignifit#245 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
wichmann-lab/python-psignifit#242 ·
-
Add a logo Open
Difficulty 5/5 Over a week Newbie friendliness 20/100
wichmann-lab/python-psignifit#237 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
wichmann-lab/python-psignifit#235 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
wichmann-lab/python-psignifit#229 · 3 comments ·
All issues in wichmann-lab/python-psignifit
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
zostera/django-bootstrap4#894 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
use-agent-os/agent-os#3276 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
NousResearch/hermes-agent#117848 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
zilliztech/memsearch#759 ·