facebook/redex

Document global g_redex

Open

#204 aberto em 6 de fev. de 2017

Ver no 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! :-)

Guia do colaborador

Pilha de tecnologia
cppandroid
Domain
documentationtooling
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
familiarity with C++understanding of RedexContext initialization
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
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.