Skip to content

[Code Quality] Servy.CLI ConsoleHelper.cs — Duplicate <summary> XML doc on RunWithLoadingAnimation #709

@Christophe-Rogiers

Description

@Christophe-Rogiers

Severity: Info

File: src/Servy.CLI/Helpers/ConsoleHelper.cs, lines 8-23

RunWithLoadingAnimation has two consecutive <summary> blocks: a detailed one with <param>/<returns>/<remarks> followed by a second, shorter <summary>. Same pattern as #704 / #708.

        /// <summary>
        /// Runs an asynchronous action while displaying a console loading spinner.
        /// The spinner shows next to a custom message until the action completes.
        /// </summary>
        /// <param name="action">The asynchronous work to execute while the spinner is shown.</param>
        /// <param name="message">
        /// The message to display next to the spinner. Defaults to "Preparing environment...".
        /// </param>
        /// <returns>A task that completes when the action finishes and the spinner is cleared.</returns>
        /// <remarks>
        /// This method runs the spinner on a background task and cancels it automatically
        /// when the action completes. The console line is cleared after the spinner stops.
        /// </remarks>
        /// <summary>
        /// Runs an asynchronous action while displaying a console loading spinner.
        /// </summary>
        public static async Task RunWithLoadingAnimation(Func<Task> action, string message = "Preparing environment...")

Suggested fix

Remove the second <summary> block at lines 21-23.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions