mccoy-lab/karyohmm

Sphinx Documentation + Tutorial

Closed

#6 opened on Sep 3, 2023

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Python (1 fork)auto 404
documentationgood first issue

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Fully implement documentation in sphinx for all API functions. Make sure all comments follow pep8 guidelines for argument definitions.

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.