Apply suggestions from code review

Co-authored-by: Thomas Pani <[email protected]>
informalsystems · Aug 18, 2023 · a168a6d · a168a6d
1 parent 71614e6
commit a168a6d
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/quint/src/ir/IRTransformer.ts b/quint/src/ir/IRTransformer.ts
@@ -274,7 +274,7 @@ export function transformType(transformer: IRTransformer, type: t.QuintType): t.
 }
 
 /**
- * Transforms a Quint declaration with a transformer, invoking the correspondent function for each
+ * Transforms a Quint declaration with a transformer, invoking the corresponding function for each
  * inner component.
  *
  * @param transformer: the IRTransformer instance with the functions to be invoked

diff --git a/quint/src/ir/IRprinting.ts b/quint/src/ir/IRprinting.ts
@@ -31,8 +31,8 @@ export function moduleToString(quintModule: QuintModule): string {
 
 /**
  * Pretty prints a declaration. Includes a type annotation if the definition is
- * annotated, or if a type is provided. The annotation is preferred over the
- * type.
+ * annotated, or if a type is provided. A type annotation, if present, takes
+ * precedence over a type provided as argument to this function.
  *
  * @param decl the Quint declaration to be formatted
  * @param includeBody optional, whether to include the body of the declaration,

diff --git a/quint/src/names/base.ts b/quint/src/names/base.ts
@@ -38,10 +38,10 @@ export type Definition = (QuintDef | ({ kind: 'param' } & QuintLambdaParameter))
   hidden?: boolean
   /* `namespaces` are names to add to the definition's name, when it
    * is copied from one module to another with a qualified name. Ordered from
-   * innermost to the outtermost. */
+   * innermost to the outermost namespace. */
   namespaces?: string[]
   /* importedFrom` is a reference to the import/instance/export statement that
-   * originated the definition, when the definition was copied from another
+   * originated the definition, if the definition was copied from another
    * module. */
   importedFrom?: QuintImport | QuintInstance | QuintExport
   /* `typeAnnotation` is the type annotation of the definition, if it has one.

diff --git a/quint/test/builders/ir.ts b/quint/test/builders/ir.ts
@@ -39,7 +39,7 @@ export function buildDef(def: string): QuintDef {
   const quintModule = buildModuleWithDecls([def])
   const decl = quintModule.declarations[0]
   if (!isDef(decl)) {
-    throw new Error(`Error trying to build def from declaration that is not a def - ${JSONbig.stringify(decl)}`)
+    throw new Error(`Error trying to build def from declaration that is not a def: ${JSONbig.stringify(decl)}`)
   }
   return decl
 }