Commit dd54aff3 authored Aug 01, 2025 by Wohlgemuth, Jason

docs: Update module documentation

parent 4b0593d0

acorn-lib/src/analyzer/mod.rs

+2 −1

Original line number	Diff line number	Diff line
		//! # Prose analyzer module
		//!
		//! This module provides interfaces for the Vale prose analyzer and functions for analyzing readability.
		//! This is where we keep functions and interfaces necessary to execute ACORN's automated editorial style guide as well as content readability analyzer.
		//!
		use crate::constants::{
		APPLICATION, CUSTOM_VALE_PACKAGE_NAME, DEFAULT_VALE_PACKAGE_URL, DISABLED_VALE_RULES, ENABLED_VALE_PACKAGES, ORGANIZATION, VALE_RELEASES_URL,
		VALE_VERSION,

acorn-lib/src/constants.rs

+3 −0

Original line number	Diff line number	Diff line
		//! # Constants, regular expressions, and configuration values
		//!
		//! This module contains a collection of regular expressions, configuration values, and guidelines for research activity data. This includes section character counts and line counts.
		//!
		use fancy_regex::Regex;
		use lazy_static::lazy_static;

acorn-lib/src/doctor/mod.rs

+2 −1

Original line number	Diff line number	Diff line
		//! # Doctor module
		//!
		//! The purpose of this module is to enable the user to more easily use ACORN in more contexts.
		//! This module gathers and displays information about the user's system and repairs any issues that may prevent ACORN from running easily.
		//!
		//! Toward this end, `acorn doctor` will
		//! * gather information about the system,
		//! * display information about the system,
		//! * and semi-automatically repair issues with the system.
		//!
		use crate::schema::validate::is_ip6;
		use crate::util::{print_values_as_table, to_string, Label, SemanticVersion};
		use human_units::FormatSize;

acorn-lib/src/lib.rs

+3 −1

Original line number	Diff line number	Diff line
		//! # ACORN Library
		//!
		//! `acorn-lib` provides functions for working with [ACORN](https://acorn.ornl.gov) data and supports the ACORN CLI.
		//! `acorn-lib` is a one-stop-shop for everything related to building and maintaining research activity data (RAD)-related technology, including the Accessible Content Optimization for Research Needs (ACORN) tool.
		//! The modules, structs, enums and constants found here support the ACORN CLI, which checks, analyzes, and exports research activity data into useable formats.
		//!
		use color_eyre::eyre;
		use derive_more::Display;
		use indicatif::{ProgressBar, ProgressStyle};

acorn-lib/src/powerpoint/mod.rs

+1 −1

Original line number	Diff line number	Diff line
		//! ## PowerPoint utilities
		//!
		//! This module provides functions for working with [`OOXML`] and creating PowerPoint documents.
		//! Here you'll find functions for working with [`OOXML`] and creating PowerPoint files.
		//!
		//! [`OOXML`]: https://en.wikipedia.org/wiki/Office_Open_XML
		use crate::schema::{ContactPoint, Metadata, Notes, Other, ResearchActivity, Sections};