Improve jsonstringify and stringify operators docs: part 2
#7748
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Looks good thanks @mateuszwilczek |
mateuszwilczek
force-pushed
the
improve-jsonstringif-1695299529
branch
from
a256ac9
to
4ae6cb0
Compare
mateuszwilczek
force-pushed
the
improve-jsonstringif-1695299529
branch
from
4ae6cb0
to
a8b1089
Compare
| <<.from-version "5.1.23">> If the suffix `rawunicode` is present, Unicode characters above 0x80 (such as ß, ä, ñ or 🎄) will be passed through unchanged. Without the suffix, they will be substituted with `\u` codes, which was the default behavior before 5.1.23. | ||
|
|
||
| <<.note """Characters outside the Basic Multilingual Plane, such as 🎄 and other emojis, will be encoded as a UTF-16 surrogate pair, i.e. with two `\u` sequences.""">> | ||
| <<.from-version "5.1.23">> If the suffix `rawunicode` is present, Unicode characters above 0x80 (such as ß, ä, ñ or 🎄) will be passed through unchanged. Without the suffix, they will be substituted with `\u` codes, which was the default behavior before 5.1.23. Characters outside the Basic Multilingual Plane, such as 🎄 and other emojis, will be encoded as a UTF-16 surrogate pair, i.e. with two `\u` sequences. |
There was a problem hiding this comment.
No critique here, just a question for the core team. How long do we keep these "New in 5.1.23" annotations around? There's been the entire 5.2.x train as well as 5.3.0 and 5.3.1, and this would likely appear in 5.3.2. Is there some official shelf-life?
There was a problem hiding this comment.
Good question! When we introduced the version tags, I was indeed thinking that we'd have some sort of statute of limitations where we'd drop the older ones. We could do it crudely by searching and replacing in an editor, but I'd prefer to update the macro so that it parses the version number and doesn't produce any output if the version is less than some threshold.
There was a problem hiding this comment.
I'll take a look into it, together with some other documentation-macro related edits I had in mind. Would a threshold of >= 5.2 be reasonable? That is, everything below 5.2 will be hidden?
|
I think the docs of the two operators in question are ready for merging now, they are more accurate and clear than before. Thanks to all that helped along the way! |
|
@Jermolene this docs update is ready for merging (it's unrelated to v5.3.2). I have figured out the differences between the operators and documented them more clearly. I have just discovered that this PR is still hanging about. |
|
Thank you @mateuszwilczek apologies for the delay. |
Relevant discussion: https://talk.tiddlywiki.org/t/are-stringify-and-jsonstringify-operators-duplicates/7760
My previous PR about this: #7650
I'm reworking the docs of these two operators to make their similarities and differences more clear.