StackGuardian / StackGuardian/tirith
docs: add docstrings across the codebase
Open
Nobody has claimed this yet.
good first issue
help wanted
- Dominant language
- Python
- Stars
- 165
- Forks
- 42
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 11
Description
Most functions in the project still lack docstrings. Contributions welcome — a good starting point
is src/tirith/core/ and each provider's handler.py.
Rules for contributing
- Use the reST docstring format:
""" Short description. :param param1: what it is :returns: what is returned :raises KeyError: when it raises """ - One file per PR, so contributors don't collide on the same file.
- Mention this issue in your PR description (e.g.
Related to #<this issue>). - PR/commit title format:
<name of the file>.py: Add docstring.
Contributor guide
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.
Research direction
Choose one file under src/tirith/core/ or a provider's handler.py, then inspect its functions and nearby documentation before editing. Add reST-format docstrings for the functions in that file, including parameters, returns, and raised exceptions where applicable. Done means one file is covered and the PR follows the required title and issue-reference format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100