Как получить тег требования к функции на docs.rs

Question

Если вы посмотрите документацию tokio на docs.rs , то есть синий тег, указывающий, что для доступа к этому API необходимо активировать функцию.

Я хотел бы включить это и для моего ящика, как это можно сделать?

Answer 1

Плохие новости: это пока что функция, доступная только на ночь.

Хорошая новость: docs.rs по умолчанию использует ночные.

---

Чтобы заставить это работать все, что вам нужно, это включить функцию doc_cfg и применить #doc(cfg) к документу

#![feature(doc_cfg)]

#[doc(cfg(feature = "macros"))]
pub fn test() {}

---

Поскольку эта функция доступна только на ночь, вы, вероятно, не хотите включать это все время. tokio определяет следующее в Cargo.toml, чтобы включить эту функцию только в docs.rs:

# docs.rs-specific configuration
[package.metadata.docs.rs]
# document all features
all-features = true
# defines the configuration attribute `docsrs`
rustdoc-args = ["--cfg", "docsrs"]

, а затем они используют

// only enables the `doc_cfg` feature when
// the `docsrs` configuration attribute is defined
#[cfg_attr(docsrs, feature(doc_cfg))]

#[cfg_attr(docsrs, doc(cfg(feature = "macros")))]
pub fn test() {}