Skip to content

Commit a9e33a6

Browse files
authored
Update README.md
1 parent 92ac97b commit a9e33a6

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ Provided is support for decoding a NestedText file or string to Ruby data struct
2727

2828
This library is inspired by Ruby's stdlib modules `JSON` and `YAML` as well as the Python [reference implementation](https://github.com/KenKundert/nestedtext) of NestedText. Parsing is done with a LL(1) recursive descent parser and dumping with a recursive DFS traversal of the object references.
2929

30-
To make this library practically useful, you should pair it with a [schema validator](#schema).
30+
> [!TIP]
31+
> To make this library practically useful, you should pair it with a [schema validator](#schema).
3132
3233
# What is NestedText?
3334
Citing from the official [introduction](https://nestedtext.org/en/latest/index.html) page:
@@ -249,7 +250,8 @@ Apple.new("granny smith", 12).to_nt
249250
NestedText::load_file('path/to/apple_dump.nt')
250251
```
251252

252-
See [encode_custom_classes_test.rb](test/nestedtext/encode_custom_classes_test.rb) for more real working examples.
253+
> [!TIP]
254+
> See [encode_custom_classes_test.rb](test/nestedtext/encode_custom_classes_test.rb) for more real working examples.
253255
254256
# Schema
255257
The point of NestedText is to not get in to business of supporting ambiguous types. That's why all values are simple strings. Having only simple strings is not useful in practice though. This is why NestedText is intended to be paired with a [Schema Validator](https://nestedtext.org/en/latest/schemas.html)!

0 commit comments

Comments
 (0)