docs: fix incorrect examples of Address.from checksum behaviour (#124)

tien · web-flow · commit 975fa4481629 · 2025-10-08T20:07:47.000+11:00
Updated documentation to clarify checksumming behavior.
diff --git a/src/core/Address.ts b/src/core/Address.ts
@@ -112,24 +112,24 @@ export declare namespace checksum {
 }
 
 /**
- * Converts a stringified address to a typed (checksummed) {@link ox#Address.Address}.
+ * Converts a stringified address to a typed (optionally checksummed) {@link ox#Address.Address}.
  *
  * @example
  * ```ts twoslash
  * import { Address } from 'ox'
  *
  * Address.from('0xa0cf798816d4b9b9866b5330eea46a18382f251e')
- * // @log: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'
+ * // @log: '0xa0cf798816d4b9b9866b5330eea46a18382f251e'
  * ```
  *
  * @example
  * ```ts twoslash
  * import { Address } from 'ox'
  *
  * Address.from('0xa0cf798816d4b9b9866b5330eea46a18382f251e', {
- *   checksum: false
+ *   checksum: true
  * })
- * // @log: '0xa0cf798816d4b9b9866b5330eea46a18382f251e'
+ * // @log: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'
  * ```
  *
  * @example

Original file line number	Diff line number	Diff line change
`@@ -112,24 +112,24 @@ export declare namespace checksum {`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`/**`
`115`		`- * Converts a stringified address to a typed (checksummed) {@link ox#Address.Address}.`
	`115`	`+ * Converts a stringified address to a typed (optionally checksummed) {@link ox#Address.Address}.`
`116`	`116`	`*`
`117`	`117`	`* @example`
`118`	`118`	* ```ts twoslash
`119`	`119`	`* import { Address } from 'ox'`
`120`	`120`	`*`
`121`	`121`	`* Address.from('0xa0cf798816d4b9b9866b5330eea46a18382f251e')`
`122`		`- * // @log: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'`
	`122`	`+ * // @log: '0xa0cf798816d4b9b9866b5330eea46a18382f251e'`
`123`	`123`	* ```
`124`	`124`	`*`
`125`	`125`	`* @example`
`126`	`126`	* ```ts twoslash
`127`	`127`	`* import { Address } from 'ox'`
`128`	`128`	`*`
`129`	`129`	`* Address.from('0xa0cf798816d4b9b9866b5330eea46a18382f251e', {`
`130`		`- * checksum: false`
	`130`	`+ * checksum: true`
`131`	`131`	`* })`
`132`		`- * // @log: '0xa0cf798816d4b9b9866b5330eea46a18382f251e'`
	`132`	`+ * // @log: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'`
`133`	`133`	* ```
`134`	`134`	`*`
`135`	`135`	`* @example`