facebook/redex

Document global g_redex

Open

#204 ouverte le 6 févr. 2017

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)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! :-)

Guide contributeur

Stack technique
cppandroid
Domaine
documentationtooling
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
familiarity with C++understanding of RedexContext initialization
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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.