Skip to content

Commit 9cfb67b

Browse files
committed
Add clarifying comments
1 parent 6f8864c commit 9cfb67b

2 files changed

Lines changed: 9 additions & 1 deletion

File tree

src/database-upload.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,8 @@ async function recordClearCleanupSizes(
205205
reports: DatabaseUploadResult[],
206206
logger: Logger,
207207
): Promise<void> {
208+
// Include both the cleanup and the re-bundling to record how much time taking this measurement adds
209+
// to the run.
208210
const startTime = performance.now();
209211

210212
try {

src/util.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -712,7 +712,13 @@ export function getBaseDatabaseOidsFilePath(config: Config): string {
712712
return path.join(config.dbLocation, BASE_DATABASE_OIDS_FILE_NAME);
713713
}
714714

715-
// Create a bundle for the given DB, if it doesn't already exist
715+
/**
716+
* Bundles the database for the given language into a `.zip` file, returning the path to it.
717+
*
718+
* If a bundle for `dbName` already exists (e.g. from an earlier call), it is deleted and
719+
* re-created, so each call produces a fresh bundle reflecting the current database contents and the
720+
* given `includeDiagnostics` value.
721+
*/
716722
export async function bundleDb(
717723
config: Config,
718724
language: Language,

0 commit comments

Comments
 (0)