hedgehogqa / hedgehogqa/fsharp-hedgehog

Name all arguments and include all type annotations in public API?

Open
#322 7 comments 0 reactions 0 assignees View on GitHub
good first issue help wanted
Dominant language
F#
Stars
284
Forks
31
PR merge metrics
No merged PRs in 30d

Description

Do we have to name all arguments and include all type annotations in the public API?

For example, I would prefer to write
https://github.com/hedgehogqa/fsharp-hedgehog/blob/569ca6915e77b274ec685ee6b5c339fbfc128bec/src/Hedgehog/Property.fs#L66-L67

as
```fsharp
let map f =
f |> Outcome.map |> GenTuple.mapSnd |> mapGen
```

If we decide to change this convention/style, know that we don't have to change the all the code at once. It can happen slowly over time, especially as we are making changes in an area.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.