Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Everything documented in the API reference should have docstrings

Open
#525 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the API reference at http://distarray.readthedocs.org/en/latest/distarray.html and identify the documented functions, classes, modules, and packages that lack docstrings. Inspect the corresponding source definitions and add the missing documentation; done means every item listed in the reference has a docstring.

Written by the indexing model from the issue text.

Description

docs easy

http://distarray.readthedocs.org/en/latest/distarray.html

If it's in this reference, it should have a docstring, including functions, classes, modules, and packages.

We're not doing too badly on this, but there are some exceptions.

Dominant language
Python
Stars
5
Forks
1
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from enthought/distarray

All issues in enthought/distarray

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.