SpinalHDL / SpinalHDL/SpinalDoc-RTD

Undocumented function check

Open
#293 1 comment 2 reactions 2 assignees View on GitHub

@Readon is already working on this.

Since Feb 28, 2026.

Dominant language
Python
Stars
32
Forks
68
No merged PRs in 30d

Description

It seems there are some Classes, methods or functions provided by SpinalHDL/SpinalHDL are widely used in project under SpinalHDL orgnization, but these facilities are not documented in this project. Please help me check which parts are missing, and write the documents if possible.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.