facebook/redex

Document global g_redex

Open

#204 opened on 2017年2月6日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)C++ (5,107 stars) (550 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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