[FIRRTL] Support for comments?
Open
Nobody has claimed this yet.
FIRRTL
- Dominant language
- C++
- Stars
- 2.2k
- Forks
- 524
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 46
Description
The scala implementation of FIRRTL already has partial support for comments (See DescriptionAnnotation and "Declaration descriptions" in the Verilog output tests). Should we support this in the FIRRTL dialect, as an optional attribute on the associated ops?
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 by reading DescriptionAnnotation and the “Declaration descriptions” cases in the Verilog output tests, then inspect the FIRRTL dialect operations that would carry such information. Determine the expected optional comment representation and verify that comments are preserved in the relevant Verilog output tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100