Add a one-line docstring to any Python solution (5 min)
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Idoneità per principianti
- 65/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia con grep -rL '"""' solutions/python/ per elencare i file Python che non contengono alcuna stringa tra triple virgolette. Apri un solutions/python/practiceN.py e individua la sua funzione main. Aggiungi un unico docstring su una riga come prima riga all'interno di quella funzione e non modificare nient'altro nel file. È fatto quando quel file contiene il docstring e il diff tocca solo quella riga.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Add a one-line docstring to any Python solution (5 min)
Most solution files have a function but no docstring. That makes it hard to understand what the function does at a glance. This issue is about adding exactly one line.
Time: ~5 minutes | Level: Complete beginner
What to do
Pick any file in solutions/python/ where the first function has no docstring. Add one line immediately after the def line:
def two_sum(nums, target):
"""Return indices of two numbers in nums that add up to target."""
...
That is the whole change. One line. You are done.
Rules
- Pick any
solutions/python/practiceN.pyfile where the main function has no docstring - Add a single
"""Short description."""line as the first line inside the function - Do not change anything else in the file
- Open a Pull Request
You can claim as many files as you want, one PR per file or batch them together.
How to find files that need a docstring:
grep -rL '"""' solutions/python/
That lists every Python file with no triple-quote string at all.
Open for everyone
This issue is open for everyone: beginners, experienced developers, students, and people who don't code at all. Any language, any level, no experience required. If you want to help, you are welcome here.
How to contribute
- Fork this repo
- Clone your fork and create a new branch
- Make your change
- Commit, push, and open a Pull Request
New to open source? Start here before anything else:
First Contributions - github.com/firstcontributions/first-contributions
Prefer video? Watch this: How to contribute on GitHub (YouTube)
If this repo helps you or you like where it is going, a star is a nice way to say thanks and helps other people find it. Entirely optional, and you do not need it to contribute.
- Lingua principale
- Python
- Stelle
- 3
- Fork
- 2
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Huerte/algo-solutions-python
-
5-minutes algorithm all-levels any-language beginner-friendly community documentation easy first-timers-only good first issue help wanted learning no-code-needed open-source python students
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
Huerte/algo-solutions-python#358 ·
-
15-minutes algorithm all-levels any-language beginner-friendly codewars good first issue hackerrank help wanted interview-prep leetcode open-source students
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
Huerte/algo-solutions-python#345 ·
-
5-minutes all-levels beginner-friendly codewars documentation good first issue hackerrank hacktoberfest interview-prep leetcode no-code-needed open-source students
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
Huerte/algo-solutions-python#343 ·
-
15-minutes 5-minutes algorithm any-language beginner-friendly c cpp csharp easy go good first issue hacktoberfest help wanted java javascript kotlin python rust swift typescript
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
Huerte/algo-solutions-python#342 ·
-
5-minutes algorithm all-levels any-language beginner-friendly community documentation easy first-timers-only good first issue help wanted learning no-code-needed open-source python students
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 78/100
Huerte/algo-solutions-python#341 ·
Tutte le issue di Huerte/algo-solutions-python
Issue simili
-
Add server: crowllm-mcpAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
pathintegral-institute/mcpm.sh#568 ·
I maintainer di solito rispondono entro 21 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
invarislabs/invaris-agentsec#98 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
Becksteinlab/imdclient#161 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
letsrevel/revel-backend#1520 ·
I maintainer di solito rispondono entro 1 giorno