appengine/findit/libs/README.md - Issue 2488113005: [Findit] Re-org code.

Side by Side Diff

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Keyboard Shortcuts

	File
u :	up to issue
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line

	Issue
u :	up to list of issues
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue

Side by Side 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 unified diff | Download patch

« appengine/findit/infra_clients/codereview/test/__init__.py ('K') | « appengine/findit/lib/gitiles/test/gitiles_repository_test.py ('k') | appengine/findit/libs/__init__.py » ('j') | appengine/findit/libs/__init__.py » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
(Empty)
	1 # libs

	2

	3 This [libs](libs) module is for shared & standalone code that has no dependency

	4 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/ s/the (standard python library)/a $1/ stgao 2016/11/16 18:44:11 Done. Show quoted text On 2016/11/15 00:38:01, wrengr wrote: > s/the (standard python library)/a $1/ Done.
	5 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/ s/-- could/-- i.e., can be/ stgao 2016/11/16 18:44:11 Done. Show quoted text On 2016/11/15 00:38:01, wrengr wrote: > s/-- could/-- i.e., can be/ Done.
	6 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 -> "For example, you must not write to the file system" In specifications, "should" indicates a desired goal (which, in practice, may fail to obtain); for absolute requirements/prohibitions, use "must" (or "shall"). stgao 2016/11/16 18:44:11 Good point. Show quoted text On 2016/11/15 00:38:01, wrengr wrote: > -> "For example, you must not write to the file system" > > In specifications, "should" indicates a desired goal (which, in practice, may > fail to obtain); for absolute requirements/prohibitions, use "must" (or > "shall"). Good point.
	7

	8 # How to use?

	9

	10 Create a symbolic link to [libs](libs), and ensure that the containing directory

	11 of it is in sys.path or PYTHONPATH.

	12

	13 The usage would look like: `from libs import API_MODULE_NAME`

OLD	NEW