Skip to content

Commit

Permalink
Add missing module docs headers
Browse files Browse the repository at this point in the history
Signed-off-by: Tomasz Pietrek <tomasz@nats.io>
  • Loading branch information
Jarema committed Jul 12, 2022
1 parent e198a63 commit 112e751
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion async-nats/src/jetstream/consumer/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//
//! Push and [Pull][PullConsumer] [Consumer] API.
//! Push and Pull [Consumer] API.

pub mod pull;
pub mod push;
Expand Down
1 change: 1 addition & 0 deletions async-nats/src/jetstream/message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! A wrapped `crate::Message` with `JetStream` related methods.
use super::context::Context;
use crate::Error;

Expand Down
2 changes: 2 additions & 0 deletions async-nats/src/jetstream/response.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! A low level `JetStream` responses.

use serde::Deserialize;

/// An error description returned in a response to a jetstream request.
Expand Down
1 change: 1 addition & 0 deletions async-nats/src/message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! A Core NATS message.
use crate::header::HeaderMap;
use crate::status::StatusCode;
use bytes::Bytes;
Expand Down
4 changes: 2 additions & 2 deletions async-nats/src/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -614,8 +614,8 @@ impl<A, T> fmt::Debug for CallbackArg1<A, T> {
}
}

/// Error report from signing callback
// this was needed because std::io::Error isn't Send
/// Error report from signing callback.
// This was needed because std::io::Error isn't Send.
#[derive(Clone)]
pub struct AuthError(String);

Expand Down
2 changes: 2 additions & 0 deletions async-nats/src/status.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! NATS status codes.

// Heavily borrowed from the http crate, would re-export since it is already a dependency
// but we have our own range of constants.
use std::convert::TryFrom;
Expand Down

0 comments on commit 112e751

Please sign in to comment.