Skip to content

Commit bf81f0f

Browse files
Copilotjosecelano
andcommitted
fix: update doc test imports to use new bootstrap module paths
Update all doc comments in bootstrap and presentation modules to reference the correct import paths after the module reorganization: - torrust_tracker_deployer_lib::logging → bootstrap::logging - torrust_tracker_deployer_lib::help → bootstrap::help This fixes the doc test failures in the testing workflow. Co-authored-by: josecelano <58816+josecelano@users.noreply.github.com>
1 parent 59b165f commit bf81f0f

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

src/bootstrap/help.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
/// # Example
3030
///
3131
/// ```rust
32-
/// use torrust_tracker_deployer_lib::help;
32+
/// use torrust_tracker_deployer_lib::bootstrap::help;
3333
///
3434
/// // Display help when user runs app without arguments
3535
/// help::display_getting_started();
@@ -73,7 +73,7 @@ pub fn display_getting_started() {
7373
/// # Example
7474
///
7575
/// ```rust
76-
/// use torrust_tracker_deployer_lib::help;
76+
/// use torrust_tracker_deployer_lib::bootstrap::help;
7777
///
7878
/// // Display troubleshooting info when user encounters issues
7979
/// help::display_troubleshooting();

src/bootstrap/logging.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
//!
2828
//! ```rust,no_run
2929
//! use std::path::Path;
30-
//! use torrust_tracker_deployer_lib::logging::{LogOutput, LogFormat, LoggingBuilder};
30+
//! use torrust_tracker_deployer_lib::bootstrap::logging::{LogOutput, LogFormat, LoggingBuilder};
3131
//!
3232
//! // Flexible builder API
3333
//! LoggingBuilder::new(Path::new("./data/logs"))
@@ -40,7 +40,7 @@
4040
//!
4141
//! ```rust,no_run
4242
//! use std::path::Path;
43-
//! use torrust_tracker_deployer_lib::logging::{LogOutput, init_compact};
43+
//! use torrust_tracker_deployer_lib::bootstrap::logging::{LogOutput, init_compact};
4444
//!
4545
//! // E2E tests - enable stderr visibility with production log location
4646
//! init_compact(Path::new("./data/logs"), LogOutput::FileAndStderr);
@@ -151,7 +151,7 @@ impl LoggingConfig {
151151
///
152152
/// ```rust,no_run
153153
/// use std::path::Path;
154-
/// use torrust_tracker_deployer_lib::logging::{LogOutput, LogFormat, LoggingBuilder};
154+
/// use torrust_tracker_deployer_lib::bootstrap::logging::{LogOutput, LogFormat, LoggingBuilder};
155155
///
156156
/// // Basic usage with defaults (Compact file format, Pretty stderr format, FileAndStderr output)
157157
/// LoggingBuilder::new(Path::new("./data/logs")).init();
@@ -314,7 +314,7 @@ impl LoggingBuilder {
314314
///
315315
/// ```rust,no_run
316316
/// use std::path::PathBuf;
317-
/// use torrust_tracker_deployer_lib::logging::{LogFormat, LogOutput, LoggingConfig, init_subscriber};
317+
/// use torrust_tracker_deployer_lib::bootstrap::logging::{LogFormat, LogOutput, LoggingConfig, init_subscriber};
318318
///
319319
/// let config = LoggingConfig::new(
320320
/// PathBuf::from("./data/logs"),
@@ -589,7 +589,7 @@ fn create_log_file_appender(log_dir: &Path) -> tracing_appender::non_blocking::N
589589
/// # Example
590590
/// ```rust,no_run
591591
/// use std::path::Path;
592-
/// use torrust_tracker_deployer_lib::logging::{LogOutput, init};
592+
/// use torrust_tracker_deployer_lib::bootstrap::logging::{LogOutput, init};
593593
///
594594
/// // E2E tests - enable stderr visibility with production location
595595
/// init(Path::new("./data/logs"), LogOutput::FileAndStderr);
@@ -632,7 +632,7 @@ pub fn init(log_dir: &Path, output: LogOutput) {
632632
/// # Example
633633
/// ```rust,no_run
634634
/// use std::path::Path;
635-
/// use torrust_tracker_deployer_lib::logging::{LogOutput, init_json};
635+
/// use torrust_tracker_deployer_lib::bootstrap::logging::{LogOutput, init_json};
636636
///
637637
/// // E2E tests - enable stderr visibility with production location
638638
/// init_json(Path::new("./data/logs"), LogOutput::FileAndStderr);
@@ -675,7 +675,7 @@ pub fn init_json(log_dir: &Path, output: LogOutput) {
675675
/// # Example
676676
/// ```rust,no_run
677677
/// use std::path::Path;
678-
/// use torrust_tracker_deployer_lib::logging::{LogOutput, init_compact};
678+
/// use torrust_tracker_deployer_lib::bootstrap::logging::{LogOutput, init_compact};
679679
///
680680
/// // E2E tests - enable stderr visibility with production location
681681
/// init_compact(Path::new("./data/logs"), LogOutput::FileAndStderr);
@@ -716,7 +716,7 @@ pub fn init_compact(log_dir: &Path, output: LogOutput) {
716716
/// # Example
717717
/// ```rust,no_run
718718
/// use std::path::Path;
719-
/// use torrust_tracker_deployer_lib::logging::{LogFormat, LogOutput, init_with_format};
719+
/// use torrust_tracker_deployer_lib::bootstrap::logging::{LogFormat, LogOutput, init_with_format};
720720
///
721721
/// // Initialize with JSON format for E2E tests with production location
722722
/// init_with_format(Path::new("./data/logs"), LogOutput::FileAndStderr, &LogFormat::Json);

src/presentation/cli/args.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ impl GlobalArgs {
8787
///
8888
/// ```rust
8989
/// # use torrust_tracker_deployer_lib::presentation::cli::args::GlobalArgs;
90-
/// # use torrust_tracker_deployer_lib::logging::{LogFormat, LogOutput, LoggingConfig};
90+
/// # use torrust_tracker_deployer_lib::bootstrap::logging::{LogFormat, LogOutput, LoggingConfig};
9191
/// # use std::path::PathBuf;
9292
/// // Create args with log configuration
9393
/// let args = GlobalArgs {

0 commit comments

Comments
 (0)