exercism / exercism/fsharp

Implement new Concept Exercise: results

Open
#861 0 comments 0 reactions 0 assignees View on GitHub
x:action/create x:knowledge/intermediate x:module/concept-exercise x:size/large x:type/content
Dominant language
F#
Stars
118
Forks
113
Avg merge
2d 12h
Merged PRs (30d)
2

Description

This issue describes how to implement the `results` concept exercise for the F# track.

## Getting started

**Please please please read the docs before starting.** Posting PRs without reading these docs will be a lot more frustrating for you during the review cycle, and exhaust Exercism's maintainers' time. So, before diving into the implementation, please read up on the following documents:

- [The features of v3](https://github.com/exercism/v3/blob/master/docs/concept-exercises.md).
- [Rationale for v3](https://github.com/exercism/v3/blob/master/docs/rationale-for-v3.md).
- [What are concept exercise and how they are structured?](https://github.com/exercism/v3/blob/master/docs/features-of-v3.md)

Please also watch the following video:

- [The Anatomy of a Concept Exercise](https://www.youtube.com/watch?v=gkbBqd7hPrA).

## Goal

The goal of this exercise is to teach the student the basics of the Concept of Results in F#.

## Learning objectives

- Know of the existing of the `Result<'T, 'TError>` type and when to use it.
- Know how to define a result value.
- Know of some basic functions in the `Result` module (like `Result.bind`) to modify results.
- Know how to use pattern matching with results.
- Know when to use `Result<'T, 'TError>` versus `Option<'T>`.

## Out of scope

- Railway-oriented programming.
- Custom computation expression to deal with results.
- Custom operators to deal with results applicatively (like `<*>`).
- Converting results to and from other types (like arrays of lists).

## Concepts

The Concepts this exercise unlocks are:

- `results`: know of the existing of the `Result<'T, 'TError>` type and when to use it; know how to define a result value; know of some basic functions in the `Result` module (like `Result; bind`) to modify results; know how to use pattern matching with results; know when to use `Result<'T, 'TError>` versus `Option<'T>`.

## Prerequisites

This exercise's prerequisites Concepts are:

- `options`: know how to work with option values, which includes working with DU's and

Any data types used in this exercise (e.g. `strings`) should also be added as prerequisites.

## Resources to refer to

### Hints

- [Results][results]: shows how results in F# work and how to use them.

### After

- [Results][results]: shows how results in F# work and how to use them.

## Representer

This exercise does not require any specific representation logic to be added to the [representer][representer].

## Analyzer

This exercise does not require any specific logic to be added to the [analyzer][analyzer].

## Implementing

To implement this exercise, please [follow these instructions](https://github.com/exercism/v3/blob/master/languages/fsharp/reference/implementing-a-concept-exercise.md).

## Help

If you have any questions while implementing the exercise, please post the questions as comments in this issue.

[how-to-implement-a-concept-exercise]: https://github.com/exercism/v3/blob/master/docs/maintainers/generic-how-to-implement-a-concept-exercise.md
[implemented-exercises]: https://github.com/exercism/v3/tree/master/languages/fsharp/exercises/concept/README.md#implemented-exercises
[reference]: https://github.com/exercism/v3/blob/master/languages/fsharp/reference/README.md#reference-docs
[analyzer]: https://github.com/exercism/fsharp-analyzer
[representer]: https://github.com/exercism/fsharp-representer
[meta-design]: https://github.com/exercism/v3/blob/master/languages/fsharp/exercises/concept/numbers/.meta/design.md
[meta-config.json]: https://github.com/exercism/v3/blob/master/languages/fsharp/exercises/concept/numbers/.meta/config.json
[docs-concept-exercises]: https://github.com/exercism/v3/blob/master/docs/concept-exercises.md
[results]: https://docs.microsoft.com/en-us/dotnet/fsharp/language-reference/results
[railway-oriented-programming]: https://fsharpforfunandprofit.com/posts/recipe-part1/#getting-started
[exceptions-vs-result]: https://danielwertheim.se/exceptions-vs-the-result-type-in-fsharp/

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.