facebook/redex

Document global g_redex

Open

#204 opened on Feb 6, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (5,107 stars) (550 forks)batch import
documentationhelp wanted

Description

There's no documentation that to use libredex you need to instantiate a RedexContext and set the global g_redex to it. This should at least be documented, or refactored around.

At least now I can find out if I can do the thing I'm trying to do! :-)

Contributor guide

Tech stack
cppandroid
Domain
documentationtooling
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
familiarity with C++understanding of RedexContext initialization
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Look at the RedexContext class definition and the global variable g redex in the codebase. Identify where g redex is used and where it should be documented. The issue requests documentation on how to properly instantiate a RedexContext and set g redex. Consider adding comments in source files or a documentation file explaining the initialization process.