Add extra documentation around glue #7174
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lukewilliamboswell
approved these changes
Oct 20, 2024
|
I think the failing test might be f flake? It runs for me locally, and I don't think it's related to these changes. |
| @@ -0,0 +1,33 @@ | |||
| # Glue | |||
|
|
|||
| Glue is a bit of tooling built into Roc to help with platform development. Roc platforms are written in a different language than Roc, and some it requires some finesse to let other languages to read and write Roc types like records and unions in a way compatible with how Roc uses those types. | |||
There was a problem hiding this comment.
The second sentence had a few typos. In the rewording below, I dropped the first "some" and added a "that's", which hopefully still has the meaning that you intended:
Roc platforms are written in a different language than Roc, and it requires some finesse to let other languages to read and write Roc types like records and unions in a way that's compatible with how Roc uses those types.
There was a problem hiding this comment.
You missed another typo :)
The second "to" in "to let other languages to read" should be dropped.
|
|
||
| The `roc glue` command generates code in other languages for interacting with the Roc types used by your platform. It takes three arguments: | ||
|
|
||
| 1. A 'glue spec', this is a Roc file specifying how to output type helpers fora particular language. You can find some examples in the src/ subdirectory: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding some documentation around Glue following a conversation in Zulip:
https://roc.zulipchat.com/#narrow/channel/304641-ideas/topic/Platform.20Cookbook
Please don't hesitate to correct me where I'm wrong. I'm very new to this, so probably made a couple of mistakes!