Fix broken rustdoc links

This commit is contained in:
Simonas Kazlauskas
2021-11-14 16:32:35 +02:00
parent 7c5a6a0eda
commit 282000ef46
3 changed files with 8 additions and 16 deletions
+3 -14
View File
@@ -26,37 +26,26 @@ jobs:
profile: minimal
components: clippy
default: true
- name: Update
uses: actions-rs/cargo@v1
with:
command: update
args: --manifest-path=Cargo.toml
- name: Clippy
uses: actions-rs/cargo@v1
with:
command: clippy
- name: Build
uses: actions-rs/cargo@v1
with:
command: build
args: --manifest-path=Cargo.toml
- name: Test
uses: actions-rs/cargo@v1
with:
command: test
args: --manifest-path=Cargo.toml -- --nocapture
args: -- --nocapture
- name: Test Release
uses: actions-rs/cargo@v1
with:
command: test
args: --manifest-path=Cargo.toml --release -- --nocapture
args: --release -- --nocapture
- name: Documentation
uses: actions-rs/cargo@v1
with:
command: doc
args: --manifest-path=Cargo.toml
env:
RUSTDOCFLAGS: --cfg docsrs
RUSTDOCFLAGS: --cfg docsrs -Drustdoc::broken_intra_doc_links
if: ${{ matrix.rust_toolchain == 'nightly' }}
windows-gnu-test:
-1
View File
@@ -36,7 +36,6 @@
//! The compiler will ensure that the loaded function will not outlive the `Library` from which it comes,
//! preventing the most common memory-safety issues.
#![cfg_attr(any(unix, windows), deny(missing_docs, clippy::all, unreachable_pub, unused))]
#![cfg_attr(docsrs, deny(broken_intra_doc_links))]
#![cfg_attr(docsrs, feature(doc_cfg))]
pub mod changelog;
+5 -1
View File
@@ -3,7 +3,6 @@ use super::Error;
use super::os::unix as imp;
#[cfg(windows)]
use super::os::windows as imp;
use super::Error;
use std::ffi::OsStr;
use std::fmt;
use std::marker;
@@ -54,6 +53,9 @@ impl Library {
/// If the `filename` specifies a library filename without a path and with the extension omitted,
/// the `.dll` extension is implicitly added on Windows.
///
/// [`os::unix::Library::new`]: crate::os::unix::Library::new
/// [`os::windows::Library::new`]: crate::os::windows::Library::new
///
/// # Tips
///
/// Distributing your dynamic libraries under a filename common to all platforms (e.g.
@@ -103,6 +105,8 @@ impl Library {
/// pointer without it being an error. If loading a null pointer is something you care about,
/// consider using the [`os::unix::Library::get_singlethreaded`] call.
///
/// [`os::unix::Library::get_singlethreaded`]: crate::os::unix::Library::get_singlethreaded
///
/// # Examples
///
/// Given a loaded library: