Add a one-line docstring to any Python solution (5 min)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 92/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Run grep -rL '"""' solutions/python/ to list candidate files, then open any solutions/python/practiceN.py and find the first def line. Add a single """Short description.""" line directly under it and leave the rest of the file untouched. Done means one file has a docstring, the diff shows only that line, and a pull request is open.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Python
- Stars
- 3
- Forks
- 2
- Avg merge
- 3h
- Merged PRs (30d)
- 44
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 Huerte/algo-solutions-python
-
5-minutes algorithm all-levels any-language beginner-friendly community documentation easy first-timers-only good first issue hacktoberfest help wanted learning no-code-needed open-source python students
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Huerte/algo-solutions-python#281 ·
Maintainers usually reply within 1 day
-
15-minutes algorithm all-levels any-language beginner-friendly codewars good first issue hackerrank help wanted interview-prep leetcode open-source students
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Huerte/algo-solutions-python#279 ·
Maintainers usually reply within 1 day
-
5-minutes beginner-friendly documentation good first issue hacktoberfest help wanted no-code-needed python
Difficulty 1/5 Under an hour Newbie friendliness 76/100
Huerte/algo-solutions-python#278 ·
Maintainers usually reply within 1 day
-
5-minutes all-levels beginner-friendly codewars documentation good first issue hackerrank hacktoberfest interview-prep leetcode no-code-needed open-source students
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Huerte/algo-solutions-python#276 ·
Maintainers usually reply within 1 day
-
Add one LeetCode, Codewars or HackerRank solution you have already solvedPossibly taken @d1vyPandey claimed this today. Open5-minutes algorithm all-levels any-language beginner-friendly codewars easy good first issue hackerrank hacktoberfest help wanted interview-prep leetcode open-source students
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Huerte/algo-solutions-python#263 · 2 comments · 1 assignee ·
Maintainers usually reply within 1 day
All issues in Huerte/algo-solutions-python
Similar issues
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
LinkedEarth/Pyleoclim_util#718 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
apache/flink-agents#1395 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
pybamm-team/PyBaMM#6061 ·
Maintainers usually reply within 2 days
-
A wall-clock ceiling in test_rest_import_off_the_loop turns the gate red on unrelated pull requestsOpenbug help wanted quality
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
pyrite-wiki/pyrite#1550 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
daniel-ospina/tortoise#13049 ·
Maintainers usually reply within 1 day