Skip to content

Commit

Permalink
Improve None/Some doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
MarijnS95 committed May 14, 2024
1 parent d690ef7 commit 4f38181
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions wayland-backend/src/client_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ pub struct WeakBackend {
impl WeakBackend {
/// Try to upgrade this weak handle to a [`Backend`]
///
/// Returns `None` if the associated backend was already dropped.
/// Returns [`None`] if the associated backend was already dropped.
pub fn upgrade(&self) -> Option<Backend> {
self.inner.upgrade().map(|backend| Backend { backend })
}
Expand Down Expand Up @@ -262,7 +262,7 @@ impl Backend {
/// This is the first step for actually reading events from the Wayland socket. See
/// [`ReadEventsGuard`] for how to use it.
///
/// This call will not block, but may return `None` if the inner queue of the backend needs to
/// This call will not block, but may return [`none`] if the inner queue of the backend needs to

Check failure on line 265 in wayland-backend/src/client_api.rs

View workflow job for this annotation

GitHub Actions / Documentation on Github Pages

unresolved link to `none`

Check failure on line 265 in wayland-backend/src/client_api.rs

View workflow job for this annotation

GitHub Actions / Documentation on Github Pages

unresolved link to `none`
/// be dispatched. In which case you should invoke
/// [`dispatch_inner_queue()`][Self::dispatch_inner_queue()].
#[inline]
Expand All @@ -278,7 +278,7 @@ impl Backend {
/// queue that the backend uses to wrap `libwayland`. While this dispatching is generally done in
/// [`ReadEventsGuard::read()`], if multiple threads are interacting with the
/// Wayland socket it can happen that this queue was filled by another thread. In that case
/// [`prepare_read()`][Self::prepare_read()] will return `None`, and you should invoke
/// [`prepare_read()`][Self::prepare_read()] will return [`None`], and you should invoke
/// this function instead of using the [`ReadEventsGuard`]
///
/// Returns the number of messages that were dispatched to their [`ObjectData`] callbacks.
Expand Down
2 changes: 1 addition & 1 deletion wayland-backend/src/server_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ pub struct WeakHandle {
impl WeakHandle {
/// Try to upgrade this weak handle to a [`Handle`]
///
/// Returns `None` if the associated backend was already dropped.
/// Returns [`None`] if the associated backend was already dropped.
#[inline]
pub fn upgrade(&self) -> Option<Handle> {
self.handle.upgrade().map(|handle| Handle { handle })
Expand Down
2 changes: 1 addition & 1 deletion wayland-client/src/conn.rs
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ impl Connection {

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

0 comments on commit 4f38181

Please sign in to comment.