From 008955d6feadfae8c4d5fa22780b82a2015f7286 Mon Sep 17 00:00:00 2001
From: Jakob Vogelsang <jakob-vogelsang@posteo.de>
Date: Mon, 30 May 2022 10:09:19 +0200
Subject: [PATCH] refactor: on review comments

---
 src/editors/substation/l-node-editor.ts |  4 ++--
 src/foundation.ts                       | 10 ++++++++--
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/src/editors/substation/l-node-editor.ts b/src/editors/substation/l-node-editor.ts
index c9ede1416a..5e448e1a20 100644
--- a/src/editors/substation/l-node-editor.ts
+++ b/src/editors/substation/l-node-editor.ts
@@ -82,7 +82,7 @@ export class LNodeEditor extends LitElement {
     return this.element.getAttribute('iedName') === 'None' ?? false;
   }
   @state()
-  private get isIedRef(): boolean {
+  private get isIEDReference(): boolean {
     return this.element.getAttribute('iedName') !== 'None';
   }
 
@@ -138,7 +138,7 @@ export class LNodeEditor extends LitElement {
         icon="delete"
         @click="${() => this.remove()}}"
       ></mwc-fab
-      >${this.isIedRef
+      >${this.isIEDReference
         ? html``
         : html`<mwc-fab
             slot="action"
diff --git a/src/foundation.ts b/src/foundation.ts
index b4411cc447..191b7d8ec6 100644
--- a/src/foundation.ts
+++ b/src/foundation.ts
@@ -2758,13 +2758,19 @@ export function getChildElementsByTagName(
   );
 }
 
-/** maxumum allow number for `lnInst` attribute */
+/** maximum value for `lnInst` attribute */
 const maxLnInst = 99;
 const lnInstRange = Array(maxLnInst)
   .fill(1)
   .map((_, i) => `${i + 1}`);
 
-/** generator function returning unique `lnInst` for a `lnClass` `LNode` element */
+/**
+ * @param parent - The LNodes' parent element to be scanned once for `lnInst`
+ * values already in use. Be sure to create a new generator every time the
+ * children of this element change.
+ * @returns a function generating increasing unused `lnInst` values for
+ * `lnClass` LNodes within `parent` on subsequent invocations
+ */
 export function newLnInstGenerator(
   parent: Element
 ): (lnClass: string) => string | undefined {