Skip to content

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

Merged
merged 6 commits into from
Jun 3, 2025

Conversation

Unisay
Copy link
Contributor

@Unisay Unisay commented May 27, 2025

Closes https://github.com/IntersectMBO/plutus-private/issues/1575

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

@Unisay Unisay temporarily deployed to github-pages May 27, 2025 16:44 — with GitHub Actions Inactive
@Unisay Unisay added the No Changelog Required Add this to skip the Changelog Check label May 27, 2025
@Unisay Unisay self-assigned this May 27, 2025
@Unisay Unisay changed the title Enhance documentation on BuiltinString and BuiltinByteString usage in Plinth Enhance documentation on BuiltinString and BuiltinByteString usage in Plinth May 27, 2025
@Unisay Unisay requested a review from a team May 27, 2025 16:45
@Unisay Unisay enabled auto-merge (squash) May 27, 2025 16:50
@Unisay Unisay requested a review from zliu41 May 28, 2025 15:31
Copy link
Member

@zliu41 zliu41 left a 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.

@Unisay Unisay force-pushed the yura/doc-string-literals branch from d1c2ce9 to 4b90287 Compare June 2, 2025 11:34
@Unisay Unisay temporarily deployed to github-pages June 2, 2025 11:34 — with GitHub Actions Inactive
@Unisay Unisay temporarily deployed to github-pages June 2, 2025 13:02 — with GitHub Actions Inactive
@Unisay Unisay force-pushed the yura/doc-string-literals branch from 32de928 to 0c77bcd Compare June 2, 2025 13:26
@Unisay Unisay temporarily deployed to github-pages June 2, 2025 13:26 — with GitHub Actions Inactive
@Unisay Unisay requested a review from zliu41 June 2, 2025 13:28
@Unisay
Copy link
Contributor Author

Unisay commented Jun 2, 2025

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.

Done: edited the doc to start each sentence from a new line.

@Unisay Unisay temporarily deployed to github-pages June 2, 2025 15:01 — with GitHub Actions Inactive
@Unisay Unisay temporarily deployed to github-pages June 2, 2025 17:30 — with GitHub Actions Inactive
…light potential data loss due to lossy conversion. Add example to illustrate truncation and promote encoding-specific newtypes.
@Unisay Unisay temporarily deployed to github-pages June 2, 2025 18:48 — with GitHub Actions Inactive
Copy link
Member

@zliu41 zliu41 left a 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.

@kwxm kwxm disabled auto-merge June 3, 2025 10:43
@kwxm kwxm merged commit 010aaf2 into master Jun 3, 2025
6 of 16 checks passed
@kwxm kwxm deleted the yura/doc-string-literals branch June 3, 2025 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
No Changelog Required Add this to skip the Changelog Check
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants