From 1403b87f6bacc0315c61f789b752565bd4a1028c Mon Sep 17 00:00:00 2001
From: Anton Strogonoff <anton@strogonoff.name>
Date: Tue, 30 Nov 2021 22:18:27 +0100
Subject: [PATCH] docs: expand, rephrase some docstrings and comments

---
 src/download.ts | 2 +-
 src/pointers.ts | 5 ++++-
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/download.ts b/src/download.ts
index a5dd851..b30edae 100644
--- a/src/download.ts
+++ b/src/download.ts
@@ -34,7 +34,7 @@ export default async function downloadBlobFromPointer(
     ? getAuthHeader(auth)
     : {};
 
-  // Request LFS metadata
+  // Request LFS transfer
 
   const lfsInfoRequestData = {
     operation: 'download',
diff --git a/src/pointers.ts b/src/pointers.ts
index 8ef02e3..561f32f 100644
--- a/src/pointers.ts
+++ b/src/pointers.ts
@@ -2,14 +2,17 @@ import path from 'path';
 
 
 interface PointerInfo {
+  /** SHA256 hash of the actual blob contents. */
   oid: string;
+
+  /** Actual blob size in bytes. */
   size: number;
 }
 
 export interface Pointer {
   info: PointerInfo;
 
-  /** Path to blob in LFS cache. */
+  /** Absolute path to actual blob in LFS cache. */
   objectPath: string;
 }