kmp5VT/ITensorCPD.jl

Missing documentation

Open

#7 opened on Jul 2, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (2 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (7 stars)
PR merge metrics
 (PR metrics pending)

Description

Need to add documentation to functions and classes to make the user experience easier

Contributor guide

Research direction
Read the existing source code to understand the functions and classes, then add docstrings following the project's documentation style.
Tech stack
None
Domain
data
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JuliaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75