-
Notifications
You must be signed in to change notification settings - Fork 483
Enhance documentation on BuiltinString
and BuiltinByteString
usage in Plinth
#7119
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
BuiltinString
and BuiltinByteString
usage in Plinth
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't remember if this is written anywhere, but in doc files we write each sentence on a separate line. This makes it easier to comment and see the diff.
doc/docusaurus/docs/using-plinth/special-functions-and-types.md
Outdated
Show resolved
Hide resolved
…types; Remove "0x" prefix.
d1c2ce9
to
4b90287
Compare
32de928
to
0c77bcd
Compare
Done: edited the doc to start each sentence from a new line. |
doc/docusaurus/docs/using-plinth/special-functions-and-types.md
Outdated
Show resolved
Hide resolved
…light potential data loss due to lossy conversion. Add example to illustrate truncation and promote encoding-specific newtypes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the example can be as simple as
ghci> unpack ("\256" :: ByteString)
[0]
But yours is fine too.
Closes https://github.com/IntersectMBO/plutus-private/issues/1575
Rendered:

(there is a glitch in the middle caused by my screenshot tool, actual documentation is ok)