SpinalHDL / SpinalHDL/SpinalDoc-RTD
Document that the string does in `SpinalEnumEncoding`
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 32
- Forks
- 68
- PR merge metrics
- No merged PRs in 30d
Description
In doc in:
https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Data%20types/enum.html#encoding
is it for the generated hdl ?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the encoding section linked in the issue and inspect the surrounding explanation of SpinalEnumEncoding. Clarify whether the string refers to generated HDL, then update that section so the meaning and scope are explicit.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100