nisrulz/sensey

[Question] Enhancement of Javadocs

Open

#11 opened on Jun 29, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Kotlin (267 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (2,658 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi. Recently I saw your update and you added javadocs, and I think for library project it's awesome. But may be it should be written more info than simple, for example, "Creates new Flip Detector", because when you write new FlipDetection(something) you already now, that you creating new Detector. I think it would be great if javadocs contained more specific info about, why we need, for example, such detector and e.t.c. What do you think about this idea?

Contributor guide

Research direction
Review the current Javadocs in the repository and identify methods like 'new FlipDetection' that lack detailed explanations. Suggest adding context on why each detector is used and its behavior.
Tech stack
kotlinandroid
Domain
mobiledocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaKotlin
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90