NVIDIA / NVIDIA/cudaqx

Add Doxygen comments for decoder configuration YAML syntax

Open
#358 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
117
Forks
74
Avg merge
2d 7h
Merged PRs (30d)
25

Description

I agree with you but I would make it an action item for after Monday.
We have to write actually lots of doxygens :)

Originally posted by @kvmto in https://github.com/NVIDIA/cudaqx/pull/345#discussion_r2527114344

Contributor guide

Open the contributing guide

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.

Research direction

The issue names decoder configuration YAML syntax but no files, tests, or entry points. Start by locating the decoder configuration definitions and existing Doxygen comments; the work is done when the relevant YAML syntax is documented consistently.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.