diff options
| author | bptato <nincsnevem662@gmail.com> | 2024-02-10 03:29:58 +0100 |
|---|---|---|
| committer | bptato <nincsnevem662@gmail.com> | 2024-02-10 03:29:58 +0100 |
| commit | c20fa2b74eadd2e637d32ebd1bf43b8bf6f9e7fa (patch) | |
| tree | 690fb8807bae10bfb1513034f97121bc05b91139 | |
| parent | 785cdc80397dbd6b1c127a7a9bd98159e71b56c9 (diff) | |
| download | chawan-c20fa2b74eadd2e637d32ebd1bf43b8bf6f9e7fa.tar.gz | |
Update docs
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | chame/htmlparseriface.nim | 12 |
2 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md index 4171f8e2..4f0d2f18 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Note: only Nim 1.6.10+ is supported. * Passes all tokenizer and tree builder tests in html5lib-tests[^1] * Includes a minimal DOM implementation * No mandatory dependencies other than the Nim standard library -* Optional character encoding support (see minidom_enc) +* Optional character encoding support (see [minidom_cs](chame/minidom_cs.nim)) * String interning support for tag and attribute names * Support for chunked parsing * document.write (no actual implementation here, but it's possible to implement diff --git a/chame/htmlparseriface.nim b/chame/htmlparseriface.nim index 2b41a586..e5d33c05 100644 --- a/chame/htmlparseriface.nim +++ b/chame/htmlparseriface.nim @@ -3,11 +3,11 @@ when defined(nimdocdummy): ## ## This exists to make implementing the DOMBuilder interface less painful. Two ## categories of hooks exist: - ## 1. Mandatory hooks: these must be implemented using static dispatch as procs. - ## Not implementing any of them will result in a compilation error. - ## 2. Optional hooks: these may be omitted if your DOM does not need them. They - ## are implemented using dynamic dispatch as methods, so we can provide - ## a default implementation (that does nothing). + ## 1. Mandatory hooks: these must be implemented by all users, or Chame will + ## not compile. + ## 2. Optional hooks: these may be omitted if your DOM does not need + ## them. (You do not have to do anything special for this, just don't + ## implement them.) ## ## Usage: ## 1. Put a type clause with your generic types in your DOM builder interface: @@ -38,7 +38,7 @@ when defined(nimdocdummy): ## otherwise you are likely to get strange compilation errors. ## ## ## Optional hooks - ## Following methods are optional hooks; implementations of this interface + ## Following procedures are optional hooks; implementations of this interface ## can choose to leave them out without getting compilation errors. ## ## ```nim |