facebook/redex

Document global g_redex

Open

#204 创建于 2017年2月6日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)C++ (5,107 star) (550 fork)batch import
documentationhelp wanted

描述

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

贡献者指南

技术栈
cppandroid
领域
documentationtooling
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
familiarity with C++understanding of RedexContext initialization
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
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.
Document global g_redex · facebook/redex#204 | Good First Issue