google / google/xls

[DSLX] emit warning: if the naming of channels appears reversed

Open
#914 0 comments 0 reactions 0 assignees View on GitHub
dslx enhancement estimate:XS
Dominant language
C++
Stars
1.9k
Forks
283
Avg merge
2d 10h
Merged PRs (30d)
135

Description

A pending change will make it so that the typing of these channels is fully determined:

```
let (s, r) = chan;
```

Where `s` is the channel that supports the `send` family of operations, and `r` is the channel that supports the `recv` family of operations (all channels in XLS are half-duplex).

Sometimes people use `_p` and `_c` suffix to indicate "producer/consumer" or "_out/_in" to indicate "producer/consumer" -- seems like it'd be helpful to flag as a warning when the naming convention seems reversed from the actual directionality of the channel types.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.