docs: add clarification to callReadOnlyFunction

mcintyre94 · janniks · commit 49a094b38aa9 · 2022-05-04T13:46:50.000+02:00
It is possible to call any public function using `callReadOnlyFunction`, not only those defined with `(define-read-only)`

This commit updates the docstring to make this more clear
diff --git a/packages/transactions/src/builders.ts b/packages/transactions/src/builders.ts
@@ -1281,7 +1281,8 @@ export interface ReadOnlyFunctionOptions {
 }
 
 /**
- * Calls a read only function from a contract interface
+ * Calls a function as read-only from a contract interface
+ * It is not necessary that the function is defined as read-only in the contract
  *
  * @param  {ReadOnlyFunctionOptions} readOnlyFunctionOptions - the options object
  *

Original file line number	Diff line number	Diff line change
`@@ -1281,7 +1281,8 @@ export interface ReadOnlyFunctionOptions {`
`1281`	`1281`	`}`
`1282`	`1282`
`1283`	`1283`	`/**`
`1284`		`- * Calls a read only function from a contract interface`
	`1284`	`+ * Calls a function as read-only from a contract interface`
	`1285`	`+ * It is not necessary that the function is defined as read-only in the contract`
`1285`	`1286`	`*`
`1286`	`1287`	`* @param {ReadOnlyFunctionOptions} readOnlyFunctionOptions - the options object`
`1287`	`1288`	`*`