crickets-and-comb / crickets-and-comb/reference_package

Documentation improvements/corrections.

Open
#16 0 comments 0 reactions 0 assignees View on GitHub
always wanted documentation enhancement help wanted
Dominant language
Python
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

We're always looking for ways to improve documentation.

For this repo, this may be in the README, in the published documentation (RST files), and in docstrings for functions, classes, and modules.

This may include corrections to typos, fact checks, prose clarification, additional sections/topics to help users, etc.

We follow the Google Python Style Guide for docstrings: https://google.github.io/styleguide/pyguide.html

NOTE: While we are certainly open to corrections to inline comments, we subscribe to the idea that code should be self-documenting. In other words, if comments are needed, it is either because the code needs to be written better (broken down into smaller modules, or named better, e.g.), or because there is a "why" or some additional context warranted. Comments should not be added to break up the code or say what the code does. The code breaks itself up and says precisely what it does already.

Contributor guide

Open the contributing guide

Research direction

Review the README, published RST documentation, and function, class, and module docstrings to identify a specific correction or clarification. Check docstrings against the Google Python Style Guide and avoid explanatory inline comments unless they provide essential context; done means a concrete documentation improvement is made and verified for accuracy.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.