chipsalliance / chipsalliance/UHDM

The hand-written classes should have documentation

Open
#74 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
269
Forks
48
Avg merge
2h 22m
Merged PRs (30d)
16

Description

The classes and functions in e.g. `include/vpi_uhdm.h` should have some documentation headers to understand the context and purpse.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the hand-written declarations in include/vpi_uhdm.h and identify the classes and functions that lack documentation headers. Done means the relevant public classes and functions have headers explaining their context and purpose; inspect nearby declarations for the project's existing documentation style.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.