@@ -32,32 +32,6 @@ pip install searchcode
3232
3333## Getting Started
3434
35- ### Code Search
36-
37- Queries the code index and returns at most 100 results.
38-
39- #### Params
40-
41- - ` query ` : Search term (required).
42- - The following filters are textual and can be added into query directly
43- - Filter by file extention ** ext: EXTENTION ** e.g., _ "gsub ext: erb "_
44- - Filter by language ** lang: LANGUAGE ** e.g., _ "import lang: python "_
45- - Filter by repository ** repo: REPONAME ** e.g., _ "float Q_rsqrt repo: quake "_
46- - Filter by user/repository ** repo: USERNAME /REPONAME** e.g., _ "batf repo: boyter /batf"_
47- - ` page ` : Result page starting at 0 through to 49
48- - ` per_page ` : Number of results wanted per page (max 100).
49- - ` languages ` : List of programming languages to filter by.
50- - ` sources ` : List of code sources (e.g., GitHub, BitBucket).
51- - ` lines_of_code_gt ` : Filter to sources with greater lines of code than supplied int. Valid values 0 to 10000.
52- - ` lines_of_code_lt ` : Filter to sources with less lines of code than supplied int. Valid values 0 to 10000.
53- - ` callback ` : Callback function (JSONP only)
54-
55- > If the results list is empty, then this indicates that you have reached the end of the available results.
56-
57- > To fetch all results for a given query, keep incrementing ` page ` parameter until you get a page with an empty results
58- > list.
59- ---
60-
6135### Code Search Without Filters
6236
6337#### Command-Line Interface
@@ -169,7 +143,27 @@ search = sc.search(query="import module", callback="myCallback")
169143pprint(search)
170144```
171145
172- `
146+ ### Params
147+
148+ - ` query ` : Search term (required).
149+ - The following filters are textual and can be added into query directly
150+ - Filter by file extention ** ext: EXTENTION ** e.g., _ "gsub ext: erb "_
151+ - Filter by language ** lang: LANGUAGE ** e.g., _ "import lang: python "_
152+ - Filter by repository ** repo: REPONAME ** e.g., _ "float Q_rsqrt repo: quake "_
153+ - Filter by user/repository ** repo: USERNAME /REPONAME** e.g., _ "batf repo: boyter /batf"_
154+ - ` page ` : Result page starting at 0 through to 49
155+ - ` per_page ` : Number of results wanted per page (max 100).
156+ - ` languages ` : List of programming languages to filter by.
157+ - ` sources ` : List of code sources (e.g., GitHub, BitBucket).
158+ - ` lines_of_code_gt ` : Filter to sources with greater lines of code than supplied int. Valid values 0 to 10000.
159+ - ` lines_of_code_lt ` : Filter to sources with less lines of code than supplied int. Valid values 0 to 10000.
160+ - ` callback ` : Callback function (JSONP only)
161+
162+ > If the results list is empty, then this indicates that you have reached the end of the available results.
163+
164+ > To fetch all results for a given query, keep incrementing ` page ` parameter until you get a page with an empty results
165+ > list.
166+ ---
173167
174168### Response Attribute Definitions
175169
0 commit comments