SpinalHDL / SpinalHDL/SpinalDoc-RTD

Document implicit Fragment -> payload conversion

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

Nobody has claimed this yet.

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

Description

https://github.com/SpinalHDL/SpinalDoc-RTD/blob/master/source/SpinalHDL/Libraries/fragment.rst

  • How to use it with example
  • Warning about getWidth
  • Seek for other similar implicit conversions (Stream, Flow, etc.) and document them too if there are things

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 with source/SpinalHDL/Libraries/fragment.rst and review its existing Fragment documentation. Compare it with the documentation for related Stream and Flow types to identify similar implicit conversions; the work is done when a usage example, the getWidth warning, and applicable conversions are documented.

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
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.