From 5aaa38bcafa78cad9588bdd7d0eff8d8f351de15 Mon Sep 17 00:00:00 2001 From: Greg Fitzgerald Date: Wed, 6 Jun 2018 11:24:24 -0600 Subject: [PATCH] Better docs for write_stage --- src/entry_writer.rs | 4 +++- src/write_stage.rs | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/entry_writer.rs b/src/entry_writer.rs index 0d174b3450..1693fa6d2d 100644 --- a/src/entry_writer.rs +++ b/src/entry_writer.rs @@ -1,4 +1,6 @@ -//! The `entry_writer` module helps implement the TPU's write stage. +//! The `entry_writer` module helps implement the TPU's write stage. It +//! writes entries to the given writer, which is typically a file or +//! stdout, and then sends the Entry to its output channel. use bank::Bank; use entry::Entry; diff --git a/src/write_stage.rs b/src/write_stage.rs index 60a55243c6..490cd8a293 100644 --- a/src/write_stage.rs +++ b/src/write_stage.rs @@ -1,4 +1,6 @@ -//! The `write_stage` module implements write stage of the RPU. +//! The `write_stage` module implements the TPU's write stage. It +//! writes entries to the given writer, which is typically a file or +//! stdout, and then sends the Entry to its output channel. use bank::Bank; use entry::Entry;