SpinalHDL / SpinalHDL/SpinalDoc-RTD

Document BU and BS string prefixes

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

Nobody has claimed this yet.

good first issue TODO
Dominant language
Python
Stars
32
Forks
68
PR merge metrics
No merged PRs in 30d

Description

Do not merge until SpinalHDL/SpinalHDL#981 has not been merged

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.

Research direction

Start by checking SpinalHDL/SpinalHDL#981, which the issue identifies as a prerequisite. After that issue is merged, determine where the SpinalHDL string-prefix documentation belongs and document the BU and BS prefixes. Done means the online documentation clearly explains both prefixes and the prerequisite is satisfied.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.