chore: Add documentation for MultiElementWrapper's get method

We got many customer questions why this method uses one-based indices. Documenting this and explaining the reason makes that explicit.
cloudscape-design · Dec 15, 2022 · c0e8ad7 · c0e8ad7
1 parent 9af6be2
commit c0e8ad7
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/core/src/selectors.ts b/packages/core/src/selectors.ts
@@ -56,6 +56,9 @@ export class MultiElementWrapper<T extends AbstractWrapper> extends ElementWrapp
     super(root);
   }
 
+  /**
+   * Index is one-based because the method uses the :nth-child() CSS pseudo-class.
+   */
   get(index: number): T {
     return this.elementFactory(`${this.root}:nth-child(${index})`);
   }