Tiny changes to make docs easier to read and API easier to use

Author: petehayes102

core/src/command/mod.rs

@@ -4,18 +4,17 @@
 // https://www.tldrlegal.com/l/mpl-2.0>. This file may not be copied,
 // modified, or distributed except according to those terms.
 
-//! Telemetry primitive.
+//! Endpoint for running shell commands.
 
-mod providers;
-
-pub use self::providers::Nix;
+pub mod providers;
 
 use erased_serde::Serialize;
 use errors::*;
 use ExecutableProvider;
 use host::Host;
-use self::providers::NixRemoteProvider;
+use self::providers::{Nix, NixRemoteProvider};
 
+#[doc(hidden)]
 #[derive(Serialize, Deserialize)]
 pub struct Command {
     shell: Vec<String>,
@@ -36,6 +35,7 @@ pub trait CommandProvider<'a> {
     fn exec(&self) -> Result<CommandResult>;
 }
 
+#[doc(hidden)]
 #[derive(Serialize, Deserialize)]
 pub enum RemoteProvider {
     Nix(NixRemoteProvider)

core/src/command/providers/nix.rs

@@ -18,6 +18,7 @@ pub struct Nix<'a> {
     inner: Command
 }
 
+#[doc(hidden)]
 #[derive(Serialize, Deserialize)]
 pub enum RemoteProvider {
     Available,

core/src/host.rs

@@ -4,7 +4,7 @@
 // https://www.tldrlegal.com/l/mpl-2.0>. This file may not be copied,
 // modified, or distributed except according to those terms.
 
-//! Host primitive.
+//! Manages the connection between the API and your host.
 
 use errors::*;
 use telemetry::{self, Telemetry};

core/src/lib.rs

@@ -6,7 +6,7 @@
 
 //! A library for configuring your servers.
 //!
-//! The library is organised into a set of _primitives_, which are
+//! The library is organised into a set of endpoints, which are
 //! the building blocks for creating complex configurations.
 
 #![recursion_limit = "1024"]
@@ -35,12 +35,14 @@ pub mod telemetry;
 use errors::*;
 use erased_serde::Serialize;
 
+#[doc(hidden)]
 pub trait ExecutableProvider<'de>: serde::Serialize + serde::Deserialize<'de> {
     // @todo It'd be nice to return Result<Serialize> here someday...
     // See https://github.com/rust-lang/rfcs/issues/518.
     fn exec(self, &host::Host) -> Result<Box<Serialize>>;
 }
 
+#[doc(hidden)]
 #[derive(Serialize, Deserialize)]
 pub enum RemoteProvider {
     Command(command::RemoteProvider),

core/src/telemetry/mod.rs

@@ -4,25 +4,25 @@
 // https://www.tldrlegal.com/l/mpl-2.0>. This file may not be copied,
 // modified, or distributed except according to those terms.
 
-//! Telemetry primitive.
+//! System generated data about your host.
 
-mod providers;
+pub mod providers;
 mod serializable;
 
-pub use self::providers::{Centos, Debian, Freebsd, Macos};
-
 use erased_serde::Serialize;
 use errors::*;
 use ExecutableProvider;
 use host::Host;
 use pnet::datalink::NetworkInterface;
-use self::providers::{CentosRemoteProvider, DebianRemoteProvider, FreebsdRemoteProvider, MacosRemoteProvider};
+use self::providers::{Centos, CentosRemoteProvider, Debian, DebianRemoteProvider,
+                      Freebsd, FreebsdRemoteProvider, Macos, MacosRemoteProvider};
 
 pub trait TelemetryProvider {
     fn available(&Host) -> bool where Self: Sized;
     fn load(&Host) -> Result<Telemetry>;
 }
 
+#[doc(hidden)]
 #[derive(Serialize, Deserialize)]
 pub enum RemoteProvider {
     Centos(CentosRemoteProvider),

core/src/telemetry/providers/centos.rs

@@ -16,6 +16,7 @@ use telemetry::{Cpu, Os, OsFamily, OsPlatform, Telemetry, TelemetryProvider, ser
 
 pub struct Centos;
 
+#[doc(hidden)]
 #[derive(Serialize, Deserialize)]
 pub enum RemoteProvider {
     Available,

core/src/telemetry/providers/debian.rs

@@ -16,6 +16,7 @@ use telemetry::{Cpu, Os, OsFamily, OsPlatform, Telemetry, TelemetryProvider, ser
 
 pub struct Debian;
 
+#[doc(hidden)]
 #[derive(Serialize, Deserialize)]
 pub enum RemoteProvider {
     Available,

core/src/telemetry/providers/freebsd.rs

@@ -17,6 +17,7 @@ use telemetry::{Cpu, Os, OsFamily, OsPlatform, Telemetry, TelemetryProvider, ser
 
 pub struct Freebsd;
 
+#[doc(hidden)]
 #[derive(Serialize, Deserialize)]
 pub enum RemoteProvider {
     Available,

core/src/telemetry/providers/macos.rs

@@ -15,6 +15,7 @@ use telemetry::{Cpu, Os, OsFamily, OsPlatform, Telemetry, TelemetryProvider, ser
 
 pub struct Macos;
 
+#[doc(hidden)]
 #[derive(Serialize, Deserialize)]
 pub enum RemoteProvider {
     Available,