veeso / suppaftp

a super FTP/FTPS client library for Rust with support for both passive and active mode
Apache License 2.0
121 stars 31 forks source link

[Feature Request] - Build the docs with doc_cfg #56

Closed JohnScience closed 1 year ago

JohnScience commented 1 year ago

Description

Some of the features of suppaftp are behind #[cfg]s , yet they are not displayed in the official documentation because the project doesn't utilize #[doc_cfg]s.

Changes

Display conditionally compiled items on docs.rs.

Implementation

You can keep the library stable while allowing the documentation to be built using the combination of --cfg, #[package.metadata], #[cfg_attr(...)], and #[cfg_doc(...)]. syn is a good example.