fix doc-lazy-continuation

Signed-off-by: Jason Volk <jason@zemos.net>

src/admin/debug/mod.rs

@@ -35,8 +35,8 @@ pub(crate) enum DebugCommand {
 	},
 
 	/// - Attempts to retrieve a PDU from a remote server. Inserts it into our
-	/// database/timeline if found and we do not have this PDU already
+	///   database/timeline if found and we do not have this PDU already
-	/// (following normal event auth rules, handles it as an incoming PDU).
+	///   (following normal event auth rules, handles it as an incoming PDU).
 	GetRemotePdu {
 		/// An event ID (a $ followed by the base64 reference hash)
 		event_id: Box<EventId>,
@@ -47,8 +47,7 @@ pub(crate) enum DebugCommand {
 	},
 
 	/// - Same as `get-remote-pdu` but accepts a codeblock newline delimited
-	///   list
+	///   list of PDUs and a single server to fetch from
-	/// of PDUs and a single server to fetch from
 	GetRemotePduList {
 		/// Argument for us to attempt to fetch all the events from the
 		/// specified remote server.

src/api/client/context.rs

@@ -13,8 +13,7 @@ use crate::{services, Error, Result, Ruma};
 /// Allows loading room history around an event.
 ///
 /// - Only works if the user is joined (TODO: always allow, but only show events
-///   if the user was
+///   if the user was joined, depending on history_visibility)
-/// joined, depending on history_visibility)
 pub(crate) async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<get_context::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");

src/api/client/message.rs

@@ -107,8 +107,7 @@ pub(crate) async fn send_message_event_route(
 /// Allows paginating through room history.
 ///
 /// - Only works if the user is joined (TODO: always allow, but only show events
-///   where the user was
+///   where the user was joined, depending on `history_visibility`)
-/// joined, depending on `history_visibility`)
 pub(crate) async fn get_message_events_route(
 	body: Ruma<get_message_events::v3::Request>,
 ) -> Result<get_message_events::v3::Response> {

src/api/client/profile.rs

@@ -50,8 +50,8 @@ pub(crate) async fn set_displayname_route(
 ///
 /// Returns the displayname of the user.
 ///
-/// - If user is on another server and we do not have a local copy already
+/// - If user is on another server and we do not have a local copy already fetch
-/// fetch displayname over federation
+///   displayname over federation
 pub(crate) async fn get_displayname_route(
 	body: Ruma<get_display_name::v3::Request>,
 ) -> Result<get_display_name::v3::Response> {
@@ -140,8 +140,8 @@ pub(crate) async fn set_avatar_url_route(
 ///
 /// Returns the `avatar_url` and `blurhash` of the user.
 ///
-/// - If user is on another server and we do not have a local copy already
+/// - If user is on another server and we do not have a local copy already fetch
-/// fetch `avatar_url` and blurhash over federation
+///   `avatar_url` and blurhash over federation
 pub(crate) async fn get_avatar_url_route(
 	body: Ruma<get_avatar_url::v3::Request>,
 ) -> Result<get_avatar_url::v3::Response> {
@@ -199,7 +199,7 @@ pub(crate) async fn get_avatar_url_route(
 /// Returns the displayname, avatar_url and blurhash of the user.
 ///
 /// - If user is on another server and we do not have a local copy already,
-/// fetch profile over federation.
+///   fetch profile over federation.
 pub(crate) async fn get_profile_route(body: Ruma<get_profile::v3::Request>) -> Result<get_profile::v3::Response> {
 	if !user_is_local(&body.user_id) {
 		// Create and update our local copy of the user

src/api/client/sync.rs

@@ -36,8 +36,7 @@ use crate::{service::pdu::EventHash, services, utils, Error, PduEvent, Result, R
 /// Synchronize the client's state with the latest state on the server.
 ///
 /// - This endpoint takes a `since` parameter which should be the `next_batch`
-///   value from a
+///   value from a previous request for incremental syncs.
-/// previous request for incremental syncs.
 ///
 /// Calling this endpoint without a `since` parameter returns:
 /// - Some of the most recent events of each timeline
@@ -49,11 +48,9 @@ use crate::{service::pdu::EventHash, services, utils, Error, PduEvent, Result, R
 /// returns: For joined rooms:
 /// - Some of the most recent events of each timeline that happened after since
 /// - If user joined the room after since: All state events (unless lazy loading
-///   is activated) and
+///   is activated) and all device list updates in that room
-/// all device list updates in that room
 /// - If the user was already in the room: A list of all events that are in the
-///   state now, but were
+///   state now, but were not in the state at `since`
-/// not in the state at `since`
 /// - If the state we send contains a member event: Joined and invited member
 ///   counts, heroes
 /// - Device list updates that happened after `since`

src/api/client/user_directory.rs

@@ -13,8 +13,7 @@ use crate::{services, Result, Ruma};
 /// Searches all known users for a match.
 ///
 /// - Hides any local users that aren't in any public rooms (i.e. those that
-///   have the join rule set to public)
+///   have the join rule set to public) and don't share a room with the sender
-/// and don't share a room with the sender
 pub(crate) async fn search_users_route(body: Ruma<search_users::v3::Request>) -> Result<search_users::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let limit = usize::try_from(body.limit).unwrap_or(10); // default limit is 10

src/api/server/key.rs

@@ -20,8 +20,7 @@ use crate::{services, Result};
 /// Gets the public signing keys of this server.
 ///
 /// - Matrix does not support invalidating public keys, so the key returned by
-///   this will be valid
+///   this will be valid forever.
-/// forever.
 // Response type for this endpoint is Json because we need to calculate a
 // signature for the response
 pub(crate) async fn get_server_keys_route() -> Result<impl IntoResponse> {
@@ -71,6 +70,5 @@ pub(crate) async fn get_server_keys_route() -> Result<impl IntoResponse> {
 /// Gets the public signing keys of this server.
 ///
 /// - Matrix does not support invalidating public keys, so the key returned by
-///   this will be valid
+///   this will be valid forever.
-/// forever.
 pub(crate) async fn get_server_keys_deprecated_route() -> impl IntoResponse { get_server_keys_route().await }