Cleanup readme and docstrings
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 20/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reviewing the repository README and Python docstrings, then check whether Sphinx or another documentation generator is configured. Clarify which repetitive type descriptions should change and what documentation output is expected; the work is done when the agreed README and docstrings describe arguments without redundant type text.
Written by the indexing model from the issue text.
Description
IMO, it's pretty silly having these docstrings just repeat the type of the argument. Rather, they should describe the argument and then whatever document generation tool we use will automatically insert the type annotations (i.e. Sphinx). Just mentioning it now though. We can deal with it later.
- Dominant language
- Python
- Stars
- 35
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
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 apertium/apertium-python
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
apertium/apertium-python#109 · 2 comments ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 35/100
apertium/apertium-python#108 · 10 comments · 1 reaction ·
-
segfaultOpen
Difficulty 4/5 3-5 days Newbie friendliness 35/100
apertium/apertium-python#106 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
apertium/apertium-python#105 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
apertium/apertium-python#102 · 3 comments ·
All issues in apertium/apertium-python
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 91/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 92/100
-
enhancement P2
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Toloka/tolokaforge#1776 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
TencentCloud/Octop#1622 ·
Maintainers usually reply within 1 day
-
[arch] gate_sync.sh: stale remote tmp files on install failure; overlapping cron runs unguardedOpenarch area:fleet priority:p3 severity:low track:hosted-product
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day