Apply suggestions from code review

Rename widget accessor + Update doc

Co-authored-by: Frédéric Collonval <[email protected]>

Author: navn-r

src/commandsAndMenu.tsx

@@ -484,6 +484,7 @@ export function addCommands(
                       )
                     });
 
+                    // Bail early if the user wants to finish resolving conflicts
                     if (!result.button.accept) {
                       return;
                     }

src/components/diff/NotebookDiff.ts

@@ -99,7 +99,7 @@ export const createNotebookDiff = async (
 
     if (model.hasConflict) {
       // FIXME: Merge view breaks when moving checkboxes to the toolbar
-      // toolbar.addItem('clear-outputs', diffWidget.nbdWidget.widgets[0])
+      // toolbar.addItem('clear-outputs', diffWidget.nbdimeWidget.widgets[0])
     }
 
     // Connect toolbar checkbox and notebook diff widget
@@ -162,7 +162,10 @@ export class NotebookDiff extends Panel implements Git.Diff.IDiffWidget {
     return this._model.hasConflict;
   }
 
-  get nbdWidget(): NotebookDiffWidget | NotebookMergeWidget {
+  /**
+   * Nbdime notebook widget.
+   */
+  get nbdimeWidget(): NotebookDiffWidget | NotebookMergeWidget {
     return this._nbdWidget;
   }
 
@@ -174,10 +177,12 @@ export class NotebookDiff extends Panel implements Git.Diff.IDiffWidget {
   }
 
   /**
-   * Checks if the conflicted file has been resolved.
+   * Checks if all conflicts have been resolved.
+   *
+   * @see https://github.com/jupyter/nbdime/blob/a74b538386d05e3e9c26753ad21faf9ff4d269d7/packages/webapp/src/app/save.ts#L2
    */
   get isFileResolved(): boolean {
-    const widget = this.nbdWidget as NotebookMergeWidget;
+    const widget = this.nbdimeWidget as NotebookMergeWidget;
     this._lastSerializeModel = widget.model.serialize();
     const validated = widget.validateMerged(this._lastSerializeModel);
     return (
@@ -186,18 +191,19 @@ export class NotebookDiff extends Panel implements Git.Diff.IDiffWidget {
   }
 
   /**
-   * Gets the file contents of a resolved merge conflict,
+   * Gets the file model of a resolved merge conflict,
    * and rejects if unable to retrieve.
    *
-   * @see https://github.com/jupyter/nbdime/blob/a74b538386d05e3e9c26753ad21faf9ff4d269d7/packages/webapp/src/app/save.ts#L20
+   * Note: `isFileResolved` is assumed to not have been called,
+   * or to have been called just before calling this method for caching purposes.
    */
   async getResolvedFile(): Promise<Partial<Contents.IModel>> {
     return Promise.resolve({
       format: 'json',
       type: 'notebook',
       content:
         this._lastSerializeModel ??
-        (this.nbdWidget as NotebookMergeWidget).model.serialize()
+        (this.nbdimeWidget as NotebookMergeWidget).model.serialize()
     });
   }
 

src/components/diff/PlainTextDiff.ts

@@ -81,7 +81,7 @@ export class PlainTextDiff extends Widget implements Git.Diff.IDiffWidget {
   }
 
   /**
-   * Gets the file contents of a resolved merge conflict,
+   * Gets the file model of a resolved merge conflict,
    * and rejects if unable to retrieve.
    */
   getResolvedFile(): Promise<Partial<Contents.IModel>> {

src/tokens.ts

@@ -481,7 +481,7 @@ export namespace Git {
        */
       isFileResolved: boolean;
       /**
-       * Gets the file contents of a resolved merge conflict,
+       * Gets the file model of a resolved merge conflict,
        * and rejects if unable to retrieve
        */
       getResolvedFile(): Promise<Partial<Contents.IModel>>;
@@ -943,12 +943,6 @@ export namespace Git {
       super('Not in a Git Repository');
     }
   }
-
-  export class ConflictedFile extends Error {
-    constructor(message: string) {
-      super(message);
-    }
-  }
 }
 
 /**