Skip to content
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

record Nick's comments on hs ledger bindings #2340

Merged
merged 1 commit into from
Jul 30, 2019
Merged

Conversation

garyverhaegen-da
Copy link
Contributor

@nickchapman-da's response to @bame-da asking about Haskell ledger bindings documentation on Slack, with small adjustments for GitHub formatting.

Copy link
Contributor

@cocreature cocreature left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like docs, thanks!


To use the bindings in this repo, you need the following `BUILD` dep:
```
"//language-support/hs/bindings:hs-ledger",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make the in this repo part bold and maybe point out explicitly that this is only for this repo since I don’t expect that most people will use it in the repo.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I've also switched the order, which I believe reads better as a logical sequence: how the code is structured, how to use in repo, how to use out of repo. (As opposed to previous commit which had how to use outside, how code is structured, how to use inside.)

Copy link
Contributor

@nickchapman-da nickchapman-da left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff. Thanks for doing this Gary.


You can find some usage examples
[here](/language-support/hs/bindings/test/DA/Ledger/Tests.hs) and
[here](/language-support/hs/bindings/examples/chat/src/DA/Chat/ChatLedger.hs).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link is broken for me

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be /language-support/hs/bindings/examples/chat/src/DA/Ledger/App/Chat/ChatLedger.hs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in #2349.

@mergify mergify bot merged commit 0b89336 into master Jul 30, 2019
@mergify mergify bot deleted the hs-bindings-readme branch July 30, 2019 16:25
Copy link
Contributor

@hurryabit hurryabit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. Thanks.


You can find some usage examples
[here](/language-support/hs/bindings/test/DA/Ledger/Tests.hs) and
[here](/language-support/hs/bindings/examples/chat/src/DA/Chat/ChatLedger.hs).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be /language-support/hs/bindings/examples/chat/src/DA/Ledger/App/Chat/ChatLedger.hs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants