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

Improve Result-chaining documentation #6952

Merged
merged 2 commits into from
Aug 1, 2024

Conversation

ageron
Copy link
Contributor

@ageron ageron commented Aug 1, 2024

This PR updates the documentation to clarify how to chain functions that return a Result.

  1. Added a note about the upcoming syntax sugar for that (i.e., the ? operator) in the roc-for-elm-programmers.md page, at the start of the backpassing section (since backpassing will be replaced, IIUC). The note links to Add syntax sugar that translates ? to Result.try #6828.
  2. Added a Result-chaining example in the tutorial, as well as a note that some syntax sugar for this is coming.

Copy link
Collaborator

@lukewilliamboswell lukewilliamboswell left a comment

Choose a reason for hiding this comment

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

Thank you

@smores56
Copy link
Sponsor Collaborator

smores56 commented Aug 1, 2024

@ageron could you sign your commit please? The CONTRIBUTING.md doc tells us how to do that for existing commits.

@ageron
Copy link
Contributor Author

ageron commented Aug 1, 2024

Sure, will do that. 👍

auto-merge was automatically disabled August 1, 2024 10:04

Head branch was pushed to by a user without write access

@ageron ageron force-pushed the improve-result-chaining-doc branch from cca533e to b6d3bb6 Compare August 1, 2024 10:04
@ageron
Copy link
Contributor Author

ageron commented Aug 1, 2024

Done, commits are now signed and github marked them as verified. I did the same for my other PRs.

@smores56 smores56 enabled auto-merge August 1, 2024 14:49
@smores56 smores56 merged commit 790eabd into roc-lang:main Aug 1, 2024
18 checks passed
@ageron ageron deleted the improve-result-chaining-doc branch August 1, 2024 21:11
Anton-4 added a commit that referenced this pull request Aug 2, 2024
Some follow-up on #6952.
@Anton-4 Anton-4 mentioned this pull request Aug 2, 2024
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.

3 participants