Skip to content

Commit 4151000

Browse files
MarijnS95ids1024
authored andcommitted
Improve None/Some doc links
1 parent 5bad415 commit 4151000

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

wayland-backend/src/client_api.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ pub struct WeakBackend {
151151
impl WeakBackend {
152152
/// Try to upgrade this weak handle to a [`Backend`]
153153
///
154-
/// Returns `None` if the associated backend was already dropped.
154+
/// Returns [`None`] if the associated backend was already dropped.
155155
pub fn upgrade(&self) -> Option<Backend> {
156156
self.inner.upgrade().map(|backend| Backend { backend })
157157
}
@@ -262,7 +262,7 @@ impl Backend {
262262
/// This is the first step for actually reading events from the Wayland socket. See
263263
/// [`ReadEventsGuard`] for how to use it.
264264
///
265-
/// This call will not block, but may return `None` if the inner queue of the backend needs to
265+
/// This call will not block, but may return [`None`] if the inner queue of the backend needs to
266266
/// be dispatched. In which case you should invoke
267267
/// [`dispatch_inner_queue()`][Self::dispatch_inner_queue()].
268268
#[inline]
@@ -278,7 +278,7 @@ impl Backend {
278278
/// queue that the backend uses to wrap `libwayland`. While this dispatching is generally done in
279279
/// [`ReadEventsGuard::read()`], if multiple threads are interacting with the
280280
/// Wayland socket it can happen that this queue was filled by another thread. In that case
281-
/// [`prepare_read()`][Self::prepare_read()] will return `None`, and you should invoke
281+
/// [`prepare_read()`][Self::prepare_read()] will return [`None`], and you should invoke
282282
/// this function instead of using the [`ReadEventsGuard`]
283283
///
284284
/// Returns the number of messages that were dispatched to their [`ObjectData`] callbacks.

wayland-backend/src/server_api.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ pub struct WeakHandle {
250250
impl WeakHandle {
251251
/// Try to upgrade this weak handle to a [`Handle`]
252252
///
253-
/// Returns `None` if the associated backend was already dropped.
253+
/// Returns [`None`] if the associated backend was already dropped.
254254
#[inline]
255255
pub fn upgrade(&self) -> Option<Handle> {
256256
self.handle.upgrade().map(|handle| Handle { handle })

wayland-client/src/conn.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ impl Connection {
177177

178178
/// Retrieve the protocol error that occured on the connection if any
179179
///
180-
/// If this method returns `Some`, it means your Wayland connection is already dead.
180+
/// If this method returns [`Some`], it means your Wayland connection is already dead.
181181
pub fn protocol_error(&self) -> Option<ProtocolError> {
182182
match self.backend.last_error()? {
183183
WaylandError::Protocol(err) => Some(err),

0 commit comments

Comments
 (0)