Skip to content

Commit d2d684f

Browse files
committed
Spellcheck README
1 parent d4e8042 commit d2d684f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,14 @@ from draftjs_exporter.html import HTML
4848
# Configuration options are detailed below.
4949
config = {}
5050

51-
# Initialise the exporter.
51+
# Initialize the exporter.
5252
exporter = HTML(config)
5353

5454
# Render a Draft.js `contentState`
5555
html = exporter.render({
5656
'entityMap': {},
5757
'blocks': [{
58-
'key': '6mgfh',
58+
'key': '6m5fh',
5959
'text': 'Hello, world!',
6060
'type': 'unstyled',
6161
'depth': 0,
@@ -191,7 +191,7 @@ def button(props):
191191
)
192192
```
193193

194-
Apart from `create_element`, a `parse_html` method is also available. Use it to interface with other HTML generators, like template engines.
194+
Apart from `create_element`, a `parse_html` method is also available. Use it to interface with other HTML generators, like template engines – at your own risk: that method does not sanitize the input.
195195

196196
See `examples.py` in the repository for more details.
197197

@@ -243,7 +243,7 @@ By default, the exporter uses a dependency-free engine called `string` to build
243243
- `lxml`.
244244
- `string_compat` (A variant of `string` with no backwards-incompatible changes since its first release).
245245

246-
The `string` engine is the fastest, and does not have any dependencies. Its only drawback is that the `parse_html` method does not escape/sanitise HTML like that of other engines.
246+
The `string` engine is the fastest, and does not have any dependencies. Its only drawback is that the `parse_html` method does not escape/sanitize HTML like that of other engines.
247247

248248
- For `html5lib`, do `pip install draftjs_exporter[html5lib]`.
249249
- For `lxml`, do `pip install draftjs_exporter[lxml]`. It also requires `libxml2` and `libxslt` to be available on your system.
@@ -293,7 +293,7 @@ class DOMListTree(DOMEngine):
293293

294294
exporter = HTML({
295295
# Use the dotted module syntax to point to the DOMEngine implementation.
296-
'engine': 'myproject.example.DOMListTree'
296+
'engine': 'my_project.example.DOMListTree'
297297
})
298298
```
299299

0 commit comments

Comments
 (0)