Skip to content

Commit

Permalink
Merge pull request #111 from mgeisler/docstring-cleanups
Browse files Browse the repository at this point in the history
Small docstring cleanups
  • Loading branch information
mgeisler authored Sep 20, 2021
2 parents c9c6364 + 889338b commit 916fac0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ jobs:

- name: Build documentation and check intra-doc links
env:
RUSTDOCFLAGS: --deny broken_intra_doc_links
RUSTDOCFLAGS: --deny rustdoc::broken_intra_doc_links
run: cargo doc --all-features --no-deps
12 changes: 3 additions & 9 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@
//! dependency on your crate. See [`assert_markdown_deps_updated`].
//!
//! * A `Changelog.md` file that should at least mention the current
//! version, gated behind the "regex_version" feature. See
//! [`assert_contains_regex`] and [`assert_contains_substring`].
//! version. See [`assert_contains_regex`] and
//! [`assert_contains_substring`].
//!
//! * The [`html_root_url`] attribute that tells other crates where to
//! find your documentation, gated behind the "html_root_url" feature.
//! See [`assert_html_root_url_updated`].
//! find your documentation. See [`assert_html_root_url_updated`].
//!
//! Except for [`assert_contains_substring`], the macros are gated
//! behind individual features, as detailed below.
Expand Down Expand Up @@ -129,8 +128,6 @@ pub use crate::markdown_deps::check_markdown_deps;
/// # Panics
///
/// If any TOML code block fails the check, `panic!` will be invoked.
///
/// [`check_markdown_deps`]: fn.check_markdown_deps.html
#[macro_export]
#[cfg(feature = "markdown_deps_updated")]
macro_rules! assert_markdown_deps_updated {
Expand Down Expand Up @@ -185,7 +182,6 @@ macro_rules! assert_markdown_deps_updated {
/// If the `html_root_url` fails the check, `panic!` will be invoked.
///
/// [api-guidelines]: https://rust-lang-nursery.github.io/api-guidelines/documentation.html#crate-sets-html_root_url-attribute-c-html-root
/// [`check_html_root_url`]: fn.check_html_root_url.html
#[macro_export]
#[cfg(feature = "html_root_url_updated")]
macro_rules! assert_html_root_url_updated {
Expand Down Expand Up @@ -315,8 +311,6 @@ macro_rules! assert_contains_substring {
///
/// If the regular expression cannot be found, `panic!` will be
/// invoked and your integration test will fail.
///
/// [`check_contains_regex`]: fn.check_contains_regex.html
#[macro_export]
#[cfg(feature = "contains_regex")]
macro_rules! assert_contains_regex {
Expand Down

0 comments on commit 916fac0

Please sign in to comment.