From 9b17d5729aafa1f457130ceeaa18283c09957899 Mon Sep 17 00:00:00 2001 From: Jimmy Cuadra Date: Sat, 15 Jun 2019 00:07:44 -0700 Subject: [PATCH] Use a consistent style for the name of the library. --- src/call.rs | 2 +- src/call/hangup.rs | 2 +- src/key/verification.rs | 10 +++++----- src/key/verification/cancel.rs | 2 +- src/key/verification/start.rs | 2 +- src/lib.rs | 20 ++++++++++---------- src/presence.rs | 2 +- src/room/encrypted.rs | 2 +- src/room/guest_access.rs | 2 +- src/room/history_visibility.rs | 2 +- src/room/join_rules.rs | 2 +- src/room/member.rs | 2 +- src/room/message.rs | 2 +- src/room/message/feedback.rs | 2 +- src/room_key_request.rs | 2 +- 15 files changed, 28 insertions(+), 28 deletions(-) diff --git a/src/call.rs b/src/call.rs index 7a53946c..916df12c 100644 --- a/src/call.rs +++ b/src/call.rs @@ -32,7 +32,7 @@ pub enum SessionDescriptionType { Offer, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, diff --git a/src/call/hangup.rs b/src/call/hangup.rs index e8a20a43..ce3fd792 100644 --- a/src/call/hangup.rs +++ b/src/call/hangup.rs @@ -37,7 +37,7 @@ pub enum Reason { InviteTimeout, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, diff --git a/src/key/verification.rs b/src/key/verification.rs index 1ce06164..0d44031e 100644 --- a/src/key/verification.rs +++ b/src/key/verification.rs @@ -19,7 +19,7 @@ pub enum HashAlgorithm { Sha256, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, @@ -39,7 +39,7 @@ pub enum KeyAgreementProtocol { Curve25519, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, @@ -59,7 +59,7 @@ pub enum MessageAuthenticationCode { HkdfHmacSha256, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, @@ -83,7 +83,7 @@ pub enum ShortAuthenticationString { Emoji, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, @@ -104,7 +104,7 @@ pub enum VerificationMethod { MSasV1, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, diff --git a/src/key/verification/cancel.rs b/src/key/verification/cancel.rs index 8f5265b6..adb73c59 100644 --- a/src/key/verification/cancel.rs +++ b/src/key/verification/cancel.rs @@ -73,7 +73,7 @@ pub enum CancelCode { Custom(String), /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] __Nonexhaustive, } diff --git a/src/key/verification/start.rs b/src/key/verification/start.rs index c6b28b7f..56670d79 100644 --- a/src/key/verification/start.rs +++ b/src/key/verification/start.rs @@ -23,7 +23,7 @@ pub enum StartEventContent { MSasV1(MSasV1Content), /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] __Nonexhaustive, } diff --git a/src/lib.rs b/src/lib.rs index cf25b557..3a66223a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,4 +1,4 @@ -//! Crate ruma_events contains serializable types for the events in the [Matrix](https://matrix.org) +//! Crate `ruma_events` contains serializable types for the events in the [Matrix](https://matrix.org) //! specification that can be shared by client and server code. //! //! All data exchanged over Matrix is expressed as an event. @@ -7,19 +7,19 @@ //! While anyone can create a new event type for their own purposes, the Matrix specification //! defines a number of event types which are considered core to the protocol, and Matrix clients //! and servers must understand their semantics. -//! ruma_events contains Rust types for each of the event types defined by the specification and +//! ruma-events contains Rust types for each of the event types defined by the specification and //! facilities for extending the event system for custom event types. //! //! # Event types //! -//! ruma_events includes a Rust enum called `EventType`, which provides a simple enumeration of +//! ruma-events includes a Rust enum called `EventType`, which provides a simple enumeration of //! all the event types defined by the Matrix specification. Matrix event types are serialized to //! JSON strings in [reverse domain name //! notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation), although the core event //! types all use the special "m" TLD, e.g. *m.room.message*. //! `EventType` also includes a variant called `Custom`, which is a catch-all that stores a string //! containing the name of any event type that isn't part of the specification. -//! `EventType` is used throughout ruma_events to identify and differentiate between events of +//! `EventType` is used throughout ruma-events to identify and differentiate between events of //! different types. //! //! # Event traits @@ -49,24 +49,24 @@ //! * Optionally, `prev_content`, a JSON object containing the `content` object from the //! previous event of the given `(event_type, state_key)` tuple in the given room. //! -//! ruma_events represents these three event kinds as traits, allowing any Rust type to serve as a +//! ruma-events represents these three event kinds as traits, allowing any Rust type to serve as a //! Matrix event so long as it upholds the contract expected of its kind. //! //! # Core event types //! -//! ruma_events includes Rust types for every one of the event types in the Matrix specification. +//! ruma-events includes Rust types for every one of the event types in the Matrix specification. //! To better organize the crate, these types live in separate modules with a hierarchy that //! matches the reverse domain name notation of the event type. //! For example, the *m.room.message* event lives at `ruma_events::room::message::MessageEvent`. //! Each type's module also contains a Rust type for that event type's `content` field, and any //! other supporting types required by the event's other fields. -//! All concrete event types in ruma_events are serializable and deserializable using the +//! All concrete event types in ruma-events are serializable and deserializable using the //! [Serde](https://serde.rs/) serialization library. //! //! # Custom events //! //! Although any Rust type that implements `Event`, `RoomEvent`, or `StateEvent` can serve as a -//! Matrix event type, ruma_events also includes a few convenience types for representing events +//! Matrix event type, ruma-events also includes a few convenience types for representing events //! that are not covered by the spec and not otherwise known by the application. //! `CustomEvent`, `CustomRoomEvent`, and `CustomStateEvent` are simple implementations of their //! respective event traits whose `content` field is simply a `serde_json::Value` value, which @@ -79,7 +79,7 @@ //! However, there are APIs in the Matrix specification that involve heterogeneous collections of //! events, i.e. a list of events of different event types. //! Because Rust does not have a facility for arrays, vectors, or slices containing multiple -//! concrete types, ruma_events provides special collection types for this purpose. +//! concrete types, ruma-events provides special collection types for this purpose. //! The collection types are enums which effectively "wrap" each possible event type of a //! particular event "kind." //! @@ -270,7 +270,7 @@ pub enum EventType { Custom(String), /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] __Nonexhaustive, } diff --git a/src/presence.rs b/src/presence.rs index e43f5a99..73c90631 100644 --- a/src/presence.rs +++ b/src/presence.rs @@ -55,7 +55,7 @@ pub enum PresenceState { Unavailable, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, diff --git a/src/room/encrypted.rs b/src/room/encrypted.rs index 4bf5a535..9b340e68 100644 --- a/src/room/encrypted.rs +++ b/src/room/encrypted.rs @@ -24,7 +24,7 @@ pub enum EncryptedEventContent { MegolmV1AesSha2(MegolmV1AesSha2Content), /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] __Nonexhaustive, } diff --git a/src/room/guest_access.rs b/src/room/guest_access.rs index a19a85c2..72466230 100644 --- a/src/room/guest_access.rs +++ b/src/room/guest_access.rs @@ -29,7 +29,7 @@ pub enum GuestAccess { Forbidden, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, diff --git a/src/room/history_visibility.rs b/src/room/history_visibility.rs index d5a93b45..3f7f7658 100644 --- a/src/room/history_visibility.rs +++ b/src/room/history_visibility.rs @@ -41,7 +41,7 @@ pub enum HistoryVisibility { WorldReadable, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, diff --git a/src/room/join_rules.rs b/src/room/join_rules.rs index 85aec720..4c324b37 100644 --- a/src/room/join_rules.rs +++ b/src/room/join_rules.rs @@ -35,7 +35,7 @@ pub enum JoinRule { Public, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, diff --git a/src/room/member.rs b/src/room/member.rs index 08e55fa1..061848a6 100644 --- a/src/room/member.rs +++ b/src/room/member.rs @@ -82,7 +82,7 @@ pub enum MembershipState { Leave, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, diff --git a/src/room/message.rs b/src/room/message.rs index d6ccf59e..10024ca9 100644 --- a/src/room/message.rs +++ b/src/room/message.rs @@ -53,7 +53,7 @@ pub enum MessageType { Video, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, diff --git a/src/room/message/feedback.rs b/src/room/message/feedback.rs index f8fc0bbd..6d6e8a75 100644 --- a/src/room/message/feedback.rs +++ b/src/room/message/feedback.rs @@ -34,7 +34,7 @@ pub enum FeedbackType { Read, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive, diff --git a/src/room_key_request.rs b/src/room_key_request.rs index 8aadcce5..f6ef22d1 100644 --- a/src/room_key_request.rs +++ b/src/room_key_request.rs @@ -43,7 +43,7 @@ pub enum Action { CancelRequest, /// Additional variants may be added in the future and will not be considered breaking changes - /// to `ruma-events`. + /// to ruma-events. #[doc(hidden)] #[serde(skip)] __Nonexhaustive,