Skip to content

Commit a596c35

Browse files
Mark imported types as doc(inline).
Gets you docs at the top level. Saves users a click. Also drops the deprecated Controller import. We need to do a breaking release anyway.
1 parent c40c08c commit a596c35

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

src/lib.rs

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,21 +101,28 @@ pub mod fat;
101101
pub mod filesystem;
102102
pub mod sdcard;
103103

104+
#[doc(inline)]
104105
pub use crate::blockdevice::{Block, BlockCount, BlockDevice, BlockIdx};
106+
107+
#[doc(inline)]
105108
pub use crate::fat::FatVolume;
109+
110+
#[doc(inline)]
106111
pub use crate::filesystem::{
107112
Attributes, Cluster, DirEntry, Directory, File, FilenameError, Mode, ShortFileName, TimeSource,
108113
Timestamp, MAX_FILE_SIZE,
109114
};
115+
116+
#[doc(inline)]
110117
pub use crate::sdcard::Error as SdCardError;
118+
119+
#[doc(inline)]
111120
pub use crate::sdcard::SdCard;
112121

113122
mod volume_mgr;
123+
#[doc(inline)]
114124
pub use volume_mgr::VolumeManager;
115125

116-
#[deprecated]
117-
pub use volume_mgr::VolumeManager as Controller;
118-
119126
#[cfg(all(feature = "defmt-log", feature = "log"))]
120127
compile_error!("Cannot enable both log and defmt-log");
121128

0 commit comments

Comments
 (0)