Datasets:
Update README.md
Browse files
README.md
CHANGED
@@ -73,12 +73,13 @@ for sample in iter(ds): print(sample["Body"])
|
|
73 |
|
74 |
## How is the text stored?
|
75 |
|
76 |
-
The original Data Dump formats the "Body" field as
|
77 |
-
This HTML format has been converted to
|
78 |
|
79 |
-
|
|
|
|
|
80 |
|
81 |
-
### Body of an example record
|
82 |
```markdown
|
83 |
According to the docs:
|
84 |
|
@@ -127,7 +128,7 @@ Additionally the existence of the `TextNode` should be noted, which represents f
|
|
127 |
Thus this text tag `<p>Hello<code>World</code></p>` would have two Jsoup child nodes `TextNode(value="Hello")` and Element(tag="code", value="World")`.
|
128 |
The value `field` of a `TextNode` contains the free standing text without any further treatment (no whitespace stripping, etc.)
|
129 |
|
130 |
-
|
131 |
|
132 |
- When ecountering a html tag for which a rule exists, children are not further traversed, **unless explicitly stated otherwise**.
|
133 |
- When encountering an `<a>` tag, `[${element.text()}](${element.attr("href")})` is emitted.
|
|
|
73 |
|
74 |
## How is the text stored?
|
75 |
|
76 |
+
The original Data Dump formats the "Body" field as HTML, using tags such as `<code>`, `<h1>`, `<ul>`, etc.
|
77 |
+
This HTML format has been converted to Markdown.
|
78 |
|
79 |
+
### Markdown format
|
80 |
+
|
81 |
+
For reference, [this post on StackOverflow](https://stackoverflow.com/questions/53253940/make-react-useeffect-hook-not-run-on-initial-render) is contained in the dataset formatted as follows:
|
82 |
|
|
|
83 |
```markdown
|
84 |
According to the docs:
|
85 |
|
|
|
128 |
Thus this text tag `<p>Hello<code>World</code></p>` would have two Jsoup child nodes `TextNode(value="Hello")` and Element(tag="code", value="World")`.
|
129 |
The value `field` of a `TextNode` contains the free standing text without any further treatment (no whitespace stripping, etc.)
|
130 |
|
131 |
+
### Traversing Rules
|
132 |
|
133 |
- When ecountering a html tag for which a rule exists, children are not further traversed, **unless explicitly stated otherwise**.
|
134 |
- When encountering an `<a>` tag, `[${element.text()}](${element.attr("href")})` is emitted.
|