ipns-record: fix lint, add context for ttl

ipfs · Oct 3, 2023 · f68df0c · f68df0c
1 parent 942569e
commit f68df0c
Showing 1 changed file with 1 addition and 2 deletions.
diff --git a/src/ipns/ipns-record.md b/src/ipns/ipns-record.md
@@ -151,11 +151,10 @@ A logical :dfn[IPNS Record] is a data structure containing the following fields:
   - Implementations MUST include this value in inside the DAG-CBOR document at `IpnsEntry.data[Sequence]`.
 
 - **TTL** (uint64)
-  - A hint for how long (in nanoseconds) the record should be cached before going back to, for instance the DHT, in order to check if it has been updated.
+  - A hint for how long (in nanoseconds) the record should be cached before going back to, for instance the DHT, in order to check if it has been updated. The function and trade-offs of this value are analogous to the TTL of DNS record.
   - Implementations MUST include this value inside the DAG-CBOR document at `IpnsEntry.data[TTL]`.
   - Suggested default: 1 hour (3 600 000 000 000 nanoseconds).
 
-
 - **Public Key** (bytes)
   - Public key used to sign this record.
     - If public key is small enough to fit in IPNS name (e.g., Ed25519 keys inlined using `identity` multihash), `IpnsEntry.pubKey` field is redundant and MAY be skipped to save space.