Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/stdlib/stream: correct comment in example code about discarded data #1474

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs/stdlib/stream: correct comment in example code about discarded data #1474

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/stdlib/stream.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,9 @@ In this example, the external device does not provide a way to pause data transm
m.d.sync += done.eq(0)
with m.Elif(self.stream.ready):
m.d.sync += self.stream.valid.eq(0)
# Payload is discarded if `done & self.stream.valid & ~self.stream.ready`.
# Pending payload in `data` is discarded if:
# `done & self.stream.valid & ~self.stream.ready`,
# and a new serial transaction begins

return m

Expand Down