Pragmatists/JUnitParams

Add explanations to examples in documentation

Open

#141 opened on Oct 27, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (887 stars) (151 forks)batch import
help wanted

Description

Without explanations of the many different ways to specify parameters, figuring out how to use this library is harder than it should be.

Also, most of the examples seem to demonstrate passing just a single parameter (or a set of parameters for a single invocation). It's not obvious how to pass several parameters.

Contributor guide

Tech stack
java
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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 JavaJUnitParams usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The issue requests adding explanations to the existing examples in the JUnitParams documentation. First, examine the current example files in the repository (likely under src/test or docs) to understand what is already there. Then, write clear comments or prose explaining the different ways to specify parameters, especially how to pass multiple parameters. The goal is to make the examples self explanatory for newcomers.