mirror of
https://github.com/Tyrrrz/DiscordChatExporter.git
synced 2026-02-14 07:43:31 -07:00
Implemented minor documentation improvements
Several minor documentation improvements suggested by copilot have been implemented.
This commit is contained in:
parent
96cf48e65a
commit
f200447761
|
|
@ -103,7 +103,7 @@ Default: 1
|
||||||
|
|
||||||
- **Normalize to UTC** - Convert all dates to UTC before exporting.
|
- **Normalize to UTC** - Convert all dates to UTC before exporting.
|
||||||
|
|
||||||
- **Export exists** Controls what the exporter should do if the current channel had previously been exported.
|
- **Export exists** - Controls what the exporter should do if the current channel had previously been exported.
|
||||||
Default: Abort
|
Default: Abort
|
||||||
|
|
||||||
- **Search for existing export** Whether the exporter should search in the entire target directory to determine whether
|
- **Search for existing export** Whether the exporter should search in the entire target directory to determine whether
|
||||||
|
|
|
||||||
|
|
@ -52,7 +52,7 @@ public abstract class ProgressLogger
|
||||||
+ $" {updateExportSuccessCount} existing channel export(s).";
|
+ $" {updateExportSuccessCount} existing channel export(s).";
|
||||||
if (updateExportSkipCount > 0)
|
if (updateExportSkipCount > 0)
|
||||||
exportSummary[ExportResult.UpdateExportSkip] =
|
exportSummary[ExportResult.UpdateExportSkip] =
|
||||||
$"Skipped {updateExportSkipCount} existing up-to-date channel export(s)";
|
$"Skipped {updateExportSkipCount} existing up-to-date channel export(s).";
|
||||||
if (exportErrorCount > 0)
|
if (exportErrorCount > 0)
|
||||||
exportSummary[ExportResult.ExportError] =
|
exportSummary[ExportResult.ExportError] =
|
||||||
$"Failed to export {exportErrorCount} channel(s) (see prior error message(s)).";
|
$"Failed to export {exportErrorCount} channel(s) (see prior error message(s)).";
|
||||||
|
|
@ -99,7 +99,7 @@ public abstract class ProgressLogger
|
||||||
/// Logs an error message about the current channel export.
|
/// Logs an error message about the current channel export.
|
||||||
/// If this is called, the count of channels that failed is automatically increased.
|
/// If this is called, the count of channels that failed is automatically increased.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="request">The request specifying the current channel export.</param>
|
/// <param name="request">The request specifying the current channel export, if it can be accessed.</param>
|
||||||
/// <param name="message">The error message about the current channel export that should be logged.</param>
|
/// <param name="message">The error message about the current channel export that should be logged.</param>
|
||||||
public abstract void LogError(ExportRequest request, string message);
|
public abstract void LogError(ExportRequest? request, string message);
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue