ThoughtWorksInc/Binding.scala

Document advanced topic "MountPoint"

Open

#166 opened on Apr 30, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (1,584 stars) (108 forks)batch import
documentationgood first issue

Description

  • what is their purpose?
  • MultiMountPoint
  • SingleMountPoint
  • using Binding[Unit] instead of SingleMountPoint in some cases

Contributor guide

Tech stack
scala
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Binding.scalaUnderstanding of MountPoint concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the Binding.scala source code for the MountPoint trait and its implementations (SingleMountPoint, MultiMountPoint). Review existing documentation in the repository's wiki or docs folder. Identify usage examples in tests or example code. Create a new document covering the purpose and usage of MountPoints, including guidance on when to use Binding[Unit] instead of SingleMountPoint.