Rust Docs

Rust Documentation Standards

Module-level Documentation

At the top of lib.rs or mod.rs:

//! # Module Name
//!
//! Brief one-line description of what this module does.
//!
//! ## Overview
//!
//! Longer explanation of the module's purpose, design decisions,
//! and how it fits into the larger system.
//!
//! ## Examples
//!
//! ```rust
//! use nebula_core::Module;
//!
//! let module = Module::new();
//! module.do_something()?;
//! ```
//!
//! ## Features
//!
//! - Feature 1: description
//! - Feature 2: description

Function Documentation

/// Brief one-line description.
///
/// Longer explanation if needed. Explain what the function does,
/// not how it does it (that's what code is for).
///
/// # Arguments
///
/// * `param1` - Description of first parameter
/// * `param2` - Description of second parameter
///
/// # Returns
///
/// Description of the return value and its meaning.
///
/// # Errors
///
/// Describes when and why this function returns an error:
///
/// * [`Error::NotFound`] - When the item doesn't exist
/// * [`Error::InvalidInput`] - When input validation fails
///
/// # Panics
///
/// Describes conditions that cause a panic (if any).
///
/// # Examples
///
/// ```rust
/// use nebula_core::process;
///
/// let result = process(42, "test")?;
/// assert_eq!(result, expected);
/// ```
///
/// # Safety
///
/// (Only for unsafe functions) Explains invariants that must be upheld.
pub fn process(param1: i32, param2: &str) -> Result<Output, Error> {
    // ...
}

Struct Documentation

/// A workflow execution context.
///
/// Contains all state needed to execute a workflow, including
/// configuration, credentials, and execution history.
///
/// # Examples
///
/// ```rust
/// use nebula_core::Context;
///
/// let ctx = Context::builder()
///     .workflow_id(id)
///     .timeout(Duration::from_secs(30))
///     .build()?;
/// ```
pub struct Context {
    /// Unique identifier for this workflow execution.
    pub id: ExecutionId,
    
    /// Maximum time allowed for execution.
    timeout: Duration,
    
    /// Credentials for external service access.
    credentials: Credentials,
}

Enum Documentation

/// Possible states of a workflow execution.
///
/// Workflows transition through these states during their lifecycle.
/// See the [state machine diagram](crate::docs::state_machine) for details.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ExecutionState {
    /// Workflow is queued but not yet started.
    Pending,
    
    /// Workflow is currently executing.
    ///
    /// Contains the timestamp when execution began.
    Running(Instant),
    
    /// Workflow completed successfully.
    Completed,
    
    /// Workflow failed with an error.
    ///
    /// Contains the error that caused the failure.
    Failed(ExecutionError),
}

Trait Documentation

/// A storage backend for workflow state.
///
/// Implementations must be thread-safe and handle concurrent access.
/// All operations should be idempotent where possible.
///
/// # Implementing
///
/// ```rust
/// use nebula_core::Storage;
///
/// struct MyStorage { /* ... */ }
///
/// impl Storage for MyStorage {
///     async fn save(&self, id: &Id, data: &Data) -> Result<(), Error> {
///         // Your implementation
///     }
/// }
/// ```
pub trait Storage: Send + Sync {
    /// Saves data with the given identifier.
    ///
    /// Overwrites any existing data with the same ID.
    async fn save(&self, id: &Id, data: &Data) -> Result<(), Error>;
    
    /// Loads data by identifier.
    ///
    /// Returns `None` if no data exists for the given ID.
    async fn load(&self, id: &Id) -> Result<Option<Data>, Error>;
}

Doc Test Patterns

Basic Example

/// ```rust
/// let x = 5;
/// assert_eq!(x, 5);
/// ```

Example with Error Handling

/// ```rust
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let result = fallible_function()?;
/// assert!(result.is_valid());
/// # Ok(())
/// # }
/// ```

Example Showing Error Case

/// ```rust,should_panic
/// let result = function_that_panics();
/// ```

Example That Shouldn't Run

/// ```rust,no_run
/// // This connects to a real server
/// let client = Client::connect("production.example.com")?;
/// ```

Example That Shouldn't Compile

/// ```rust,compile_fail
/// let x: i32 = "not a number"; // This won't compile
/// ```

Link Patterns

/// Uses [`OtherType`] for processing.
/// See [`module::function`] for details.
/// Returns [`Result<T, Error>`](std::result::Result).

Verification Commands

# Build documentation
cargo doc --no-deps --workspace

# Open in browser
cargo doc --no-deps --open

# Run doc tests
cargo test --doc --workspace

# Check for broken links
cargo doc --no-deps 2>&1 | grep -i "warning"

# Check documentation coverage (requires nightly)
RUSTDOCFLAGS="-Z unstable-options --show-coverage" cargo +nightly doc --no-deps

API Guidelines Checklist (C-* conventions)

Naming (C-CASE)

• Types: UpperCamelCase (WorkflowEngine, NodeId)
• Functions/methods: snake_case (execute_node, get_value)
• Constants: SCREAMING_SNAKE_CASE (MAX_RETRIES, DEFAULT_TIMEOUT)
• Crate names: kebab-case (nebula-core, nebula-value)

Conversions (C-CONV)

• as_ prefix: cheap reference-to-reference (as_str, as_bytes)
• to_ prefix: expensive conversion (to_string, to_vec)
• into_ prefix: ownership transfer (into_inner, into_boxed_slice)
• from_ prefix: constructors from other types (from_str, from_utf8)

Getters (C-GETTER)

• Field access: no get_ prefix (fn len(), not fn get_len())
• Fallible getters: use get (fn get(&self, key: K) -> Option<&V>)

Iterators (C-ITER)

• iter() - returns Iterator<Item = &T>
• iter_mut() - returns Iterator<Item = &mut T>
• into_iter() - returns Iterator<Item = T> (consumes collection)

Common Traits to Implement (C-COMMON-TRAITS)

• Debug - always (derive or manual)
• Clone - if sensible
• Default - if there's a sensible default
• PartialEq, Eq - if equality makes sense
• Hash - if used as HashMap key
• Send, Sync - if thread-safe

Conversion Traits (C-CONV-TRAITS)

• From<T> - infallible conversion (auto-implements Into)
• TryFrom<T> - fallible conversion
• AsRef<T> - cheap reference conversion
• Deref - for smart pointer types only

Serde (C-SERDE)

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Config {
    #[serde(default)]
    pub timeout_seconds: u64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub optional_field: Option<String>,
}

Type Safety (C-NEWTYPE, C-CUSTOM-TYPE)

// Use newtypes for type-safe IDs
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct WorkflowId(Uuid);

// Use enums for constrained values
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Priority {
    Low,
    Normal,
    High,
    Critical,
}

Future Proofing (C-SEALED, C-STRUCT-PRIVATE)

// Sealed trait - prevents external implementations
mod private {
    pub trait Sealed {}
}

pub trait MyTrait: private::Sealed { /* ... */ }

// Non-exhaustive enum - allows adding variants
#[non_exhaustive]
pub enum Error {
    Io(std::io::Error),
    Parse(ParseError),
    // Future variants won't break downstream code
}

// Private field for extensibility
pub struct Options {
    pub timeout: Duration,
    pub retries: u32,
    // Private field prevents struct literal construction
    _private: (),
}

Best Practices

1. Write for the reader: Assume they know Rust but not your code
2. Examples are mandatory: Every public item needs a working example
3. Document errors: List all error conditions for fallible functions
4. Link generously: Use [backticks] to link to related items
5. Keep it current: Update docs when code changes
6. Use American English for consistency