llvm / llvm/circt

[FIRRTL] Intrinsic documentation: Ports and Direction tables are bit confusing

Open
#8,111 0 comments 0 reactions 0 assignees View on GitHub
documentation FIRRTL
Dominant language
C++
Stars
2.2k
Forks
524
Avg merge
3d 2h
Merged PRs (30d)
46

Description

Revisit "port" and "direction" nomenclature used in the intrinsic documentation, which are holdovers from intrinsic modules.

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the intrinsic documentation and review the Ports and Direction tables, starting with the use of “port” and “direction.” Revisit those terms in the context of intrinsic modules and update the documentation so the nomenclature is no longer confusing.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.