fgerlits commented on code in PR #1391:
URL: https://github.com/apache/nifi-minifi-cpp/pull/1391#discussion_r979882035


##########
libminifi/include/core/flow/README.md:
##########
@@ -0,0 +1,57 @@
+## Differences between JSON and YAML implementation
+
+### YAML
+
+The possible types of a `YAML::Node` are:
+* Undefined
+* Null
+* Map
+* Sequence
+* Scalar
+
+#### Undefined
+
+The result of querying any member of `Null`, querying non-existing members of 
`Map`,
+or non-existing indices of `Sequence`.
+
+Note that for `Map`s string conversion applies `map[0]` could be valid, given 
a key `"0"`,
+while for `Sequence`s string index parsing does NOT happen `seq["0"]`
+will return `Undefined` even if the sequence is non-empty.
+
+Querying or otherwise accessing an `Undefined` (other than `operator bool` or 
`IsDefined`) usually throws.
+
+#### Null
+
+The value of parsing an empty document, the value of a `Map` item with empty 
value,
+the value of an omitted `Sequence` item.
+
+```
+key1:      # this is a Null
+key2: ''   # this is a Scalar, the empty string
+arr:
+  - one
+  -        # Null as well
+  - three
+```
+
+#### Scalar
+
+A string value, all conversions to numbers happen on the fly.
+
+### Conversions
+
+#### 1. `::as<std::string>`
+
+* `Null` --> `"null"`
+* `Scalar` --> the string value
+* others --> throws
+
+#### 2. `::as<YAML::Node>`

Review Comment:
   You're right, I hadn't upgraded Clion in a while, and now that I've upgraded 
to 2022.2.3, it is now the other way round :(
   
   But on GitHub itself, `<...>` works and `&lt;...&gt;` doesn't, so I still 
think changing to `<...>` is the right way to go, even if it is going to look 
bad in Clion.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to