leostera / leostera/reason-design-patterns

Mention modules with mutually recursive types in "1 module for 1 thing"

Open
#12 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Reason
Stars
572
Forks
20
PR merge metrics
No merged PRs in 30d

Description

I think that adding a mention of mutually recursive types encapsuled in their own module as described in this blogpost in the "1 Module for 1 Thing" article
can be useful as this is a rather common case.

What do you think about this?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read patterns/1-module-1-thing.md and the linked Jane Street blog post about recursive modules. Update the article with an accurate mention of mutually recursive types encapsulated in their own module, preserving the article’s existing style and linking to the reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.