rescript-lang / rescript-lang/rescript-lang.org

Move private let bindings to a better spot

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

Nobody has claimed this yet.

Dominant language
MDX
Stars
1.9k
Forks
260
Avg merge
3d 9h
Merged PRs (30d)
17

Description

There seems to be a section about %%private let bindings in the let binding section, but it kinda mixes up a few concepts that weren't covered yet (public / private, modules, data hiding):

https://rescript-lang.org/docs/manual/latest/let-binding#private-let-bindings

This section should be kept way shorter, and then forwarded to an advanced section explaining data hiding in more detail, when all the major concepts have been introduced from a chronological standpoint.

Contributor guide

Open the contributing guide

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

Start by reading the private let bindings section at the linked let-binding documentation page and inspect the surrounding manual structure for the appropriate advanced section. Shorten the current section, move the detailed discussion of public/private visibility, modules, and data hiding to a later section, and verify that the documentation follows a chronological introduction of these concepts.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/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.