Skip to content

Commit 69f16a5

Browse files
committed
Fixed docs
Verified `cargo doc --all-features` works Signed-off-by: Jim Crossley <[email protected]>
1 parent 538b647 commit 69f16a5

File tree

8 files changed

+7
-22
lines changed

8 files changed

+7
-22
lines changed

src/actix/mod.rs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! This crate integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [Actix web](https://docs.rs/actix-web/) to easily send and receive CloudEvents.
1+
//! This module integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [Actix web](https://docs.rs/actix-web/) to easily send and receive CloudEvents.
22
//!
33
//! To deserialize an HTTP request as CloudEvent:
44
//!
@@ -38,10 +38,7 @@
3838
//! )
3939
//! }
4040
//! ```
41-
//!
42-
//! Check out the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) docs for more details on how to use [`cloudevents::Event`]
4341
44-
#![doc(html_root_url = "https://docs.rs/cloudevents-sdk/0.3.1")]
4542
#![deny(broken_intra_doc_links)]
4643

4744
#[macro_use]

src/lib.rs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,9 @@
2929
//! * The [`EventBuilder`] trait and implementations, to create [`Event`] instances
3030
//! * The implementation of [`serde::Serialize`] and [`serde::Deserialize`] for [`Event`] to serialize/deserialize CloudEvents to/from JSON
3131
//! * Traits and utilities in [`message`] to implement Protocol Bindings
32-
//!
33-
//! If you're looking for Protocol Binding implementations, look at crates:
34-
//!
35-
//! * [cloudevents-sdk-actix-web](https://docs.rs/cloudevents-sdk-actix-web): Integration with [Actix Web](https://github.com/actix/actix-web)
36-
//! * [cloudevents-sdk-reqwest](https://docs.rs/cloudevents-sdk-reqwest): Integration with [reqwest](https://github.com/seanmonstar/reqwest)
37-
//! * [cloudevents-sdk-rdkafka](https://docs.rs/cloudevents-sdk-rdkafka): Integration with [rdkafka](https://fede1024.github.io/rust-rdkafka)
32+
//! * Feature-guarded modules for various Protocol Binding implementations, e.g. actix, reqwest, warp, rdkafka
3833
//!
3934
40-
#![doc(html_root_url = "https://docs.rs/cloudevents-sdk/0.3.1")]
4135
#![deny(broken_intra_doc_links)]
4236

4337
#[cfg(feature = "cloudevents-actix")]

src/rdkafka/kafka_producer_record.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use rdkafka::producer::{BaseRecord, FutureRecord};
1111
/// Implements [`StructuredSerializer`] & [`BinarySerializer`] traits.
1212
///
1313
/// To instantiate a new `MessageRecord` from an [`Event`],
14-
/// look at [`Self::from_event`] or use [`StructuredDeserializer::deserialize_structured`](cloudevents::message::StructuredDeserializer::deserialize_structured)
14+
/// look at [`Self::from_event`] or use [`StructuredDeserializer::deserialize_structured`](crate::message::StructuredDeserializer::deserialize_structured)
1515
/// or [`BinaryDeserializer::deserialize_binary`].
1616
pub struct MessageRecord {
1717
pub(crate) headers: OwnedHeaders,

src/rdkafka/mod.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@
4848
//! # }
4949
//! ```
5050
51-
#![doc(html_root_url = "https://docs.rs/cloudevents-sdk/0.3.1")]
5251
#![deny(broken_intra_doc_links)]
5352

5453
#[macro_use]

src/reqwest/mod.rs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! This crate integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [reqwest](https://docs.rs/reqwest/) to easily send and receive CloudEvents.
1+
//! This module integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [reqwest](https://docs.rs/reqwest/) to easily send and receive CloudEvents.
22
//!
33
//! ```
44
//! use cloudevents::reqwest::{RequestBuilderExt, ResponseExt};
@@ -26,10 +26,7 @@
2626
//! # Ok(())
2727
//! # }
2828
//! ```
29-
//!
30-
//! Check out the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) docs for more details on how to use [`cloudevents::Event`].
3129
32-
#![doc(html_root_url = "https://docs.rs/cloudevents-sdk/0.3.1")]
3330
#![deny(broken_intra_doc_links)]
3431

3532
#[macro_use]

src/warp/filter.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pub struct EventFilterError {
1313
impl warp::reject::Reject for EventFilterError {}
1414

1515
///
16-
/// # Extracts [`cloudevents::Event`] from incoming request
16+
/// # Extracts [`crate::Event`] from incoming request
1717
///
1818
/// ```
1919
/// use cloudevents::warp::filter::to_event;

src/warp/mod.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! This crate integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [Warp web service framework](https://docs.rs/warp/)
1+
//! This module integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [Warp web service framework](https://docs.rs/warp/)
22
//! to easily send and receive CloudEvents.
33
//!
44
//! To deserialize an HTTP request as CloudEvent
@@ -57,8 +57,6 @@
5757
//! });
5858
//! warp::serve(routes).run(([127, 0, 0, 1], 3030));
5959
//! ```
60-
//!
61-
//! Check out the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) docs for more details on how to use [`cloudevents::Event`]
6260
6361
#[macro_use]
6462
mod headers;

src/warp/reply.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use http::StatusCode;
55
use warp::reply::Response;
66

77
///
8-
/// # Serializes [`cloudevents::Event`] as a http response
8+
/// # Serializes [`crate::Event`] as a http response
99
///
1010
/// ```
1111
/// use cloudevents::warp::reply::from_event;

0 commit comments

Comments
 (0)