Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2167)

Unified Diff: appengine/findit/libs/README.md

Issue 2488113005: [Findit] Re-org code. (Closed)
Patch Set: Address comments. Created 4 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: appengine/findit/libs/README.md
diff --git a/appengine/findit/libs/README.md b/appengine/findit/libs/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..37fcfc48ef5ddeb945a60ef7c1d0a7bf4c285e98
--- /dev/null
+++ b/appengine/findit/libs/README.md
@@ -0,0 +1,13 @@
+# libs
+
+This [libs](libs) module is for shared & standalone code that has no dependency
+on AppEngine but just the standard python library. However, it should also be
wrengr 2016/11/15 00:38:01 s/the (standard python library)/a $1/
stgao 2016/11/16 18:44:11 Done.
+AppEngine-compatible -- could run on AppEngine. For example, writing to the file
wrengr 2016/11/15 00:38:01 s/-- could/-- i.e., can be/
stgao 2016/11/16 18:44:11 Done.
+system should be excluded (os.path is OK though).
wrengr 2016/11/15 00:38:01 -> "For example, you must not write to the file sy
stgao 2016/11/16 18:44:11 Good point.
+
+# How to use?
+
+Create a symbolic link to [libs](libs), and ensure that the containing directory
+of it is in sys.path or PYTHONPATH.
+
+The usage would look like: `from libs import API_MODULE_NAME`

Powered by Google App Engine
This is Rietveld 408576698