Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Apply #[doc(cfg(feature = "..."))] banners in docs #734

Closed
wants to merge 6 commits into from
Closed

Apply #[doc(cfg(feature = "..."))] banners in docs #734

wants to merge 6 commits into from

Commits on Dec 15, 2019

  1. Prodvide a cfg for the doc-cfg feature 

    To be able to include banners, which feature is needed for an item, the
feature `#![feature(doc_cfg)]` has to be available. This feture is only
available in nightly compiler since August 2017. So we need to detect,
whether we are building the docs under a nightly compiler to add the
doc-cfg-banners.
    @jfrimmel
    jfrimmel committed Dec 15, 2019
    Configuration menu
    Copy the full SHA
    f7aee84 View commit details
    Browse the repository at this point in the history

  2. Enable doc_cfg feature conditionally 

    This enables the usage of the #[doc(cfg(...))] attributes.
    @jfrimmel
    jfrimmel committed Dec 15, 2019
    Configuration menu
    Copy the full SHA
    a523669 View commit details
    Browse the repository at this point in the history

Commits on Dec 16, 2019

  1. Apply #[doc(cfg(..))] attributes to public types

    @jfrimmel
    jfrimmel committed Dec 16, 2019
    Configuration menu
    Copy the full SHA
    078af2b View commit details
    Browse the repository at this point in the history

  2. Apply #[doc(cfg(..))] attributes to public fns

    @jfrimmel
    jfrimmel committed Dec 16, 2019
    Configuration menu
    Copy the full SHA
    707dfad View commit details
    Browse the repository at this point in the history

Commits on Dec 19, 2019

  1. Enable #[doc(cfg(..))] for docs.rs builds only

    @jfrimmel
    jfrimmel committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    f09a3e3 View commit details
    Browse the repository at this point in the history

  2. Simplify some #[doc(cfg(..))]s

    @jfrimmel
    jfrimmel committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    1777a33 View commit details
    Browse the repository at this point in the history