Skip to content

Conversation

taiki-e
Copy link
Member

@taiki-e taiki-e commented Nov 23, 2021

Motivation

The behavior introduced in rust-lang/rust#89596 (auto doc_cfg) is now split to another feature flag (rust-lang/rust#90502).

We can remove some changes done in #4193.

@taiki-e taiki-e requested a review from Darksonn November 23, 2021 03:21
As of the latest nightly, this is a warning by default and we deny doc warnings
on CI.

Refs: https://doc.rust-lang.org/rustdoc/lints.html#broken_intra_doc_links
Comment on lines -19 to -22
#![cfg_attr(docsrs, feature(doc_cfg_hide))]
#![cfg_attr(docsrs, doc(cfg_hide(docsrs)))]
#![cfg_attr(docsrs, doc(cfg_hide(loom)))]
#![cfg_attr(docsrs, doc(cfg_hide(not(loom))))]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you verified that the documentation still looks alright after removing these?

Copy link
Member Author

@taiki-e taiki-e Nov 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

nightly-2021-11-23, on taiki-e/doc_cfg branch:

cd tokio
RUSTDOCFLAGS='--cfg docsrs' cargo +nightly-2021-11-23 doc --all-features --open

11-23

nightly-2021-10-25, on taiki-e/doc_cfg branch:

cd tokio
RUSTDOCFLAGS='--cfg docsrs' cargo +nightly-2021-10-25 doc --all-features --open

10-25

EDIT: The first image I posted had the date reversed.

feature = "process",
all(unix, feature = "signal"),
))]
#[cfg_attr(docsrs, doc(cfg(all())))]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nightly-2021-11-23:
11-23

nightly-2021-10-25:
10-25

@Darksonn Darksonn added A-ci Area: The continuous integration setup T-docs Topic: documentation labels Nov 23, 2021
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming that the docs still look good, this LGTM.

@taiki-e taiki-e merged commit a8b662f into master Nov 23, 2021
@taiki-e taiki-e deleted the taiki-e/doc_cfg branch November 23, 2021 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-ci Area: The continuous integration setup T-docs Topic: documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants