SpinalHDL / SpinalHDL/SpinalDoc-RTD
Document setWhen and clearWhen
Open
Nobody has claimed this yet.
good first issue
- Dominant language
- Python
- Stars
- 32
- Forks
- 68
- PR merge metrics
- No merged PRs in 30d
Description
Should be in: https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Sequential%20logic/registers.html
(source: https://github.com/SpinalHDL/SpinalDoc-RTD/blob/master/source/SpinalHDL/Sequential%20logic/registers.rst)
Simplified example:
val inFrameLate = Reg(Bool) setWhen(!sclRead) clearWhen(!inFrame)
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
Open source/SpinalHDL/Sequential logic/registers.rst and inspect the register documentation around the provided example. Add an explanation of setWhen and clearWhen using the simplified Scala snippet, then verify the generated registers page includes the new documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100