Skip to content

Commit abe0c2f

Browse files
docs: translate comments to English in rest/search.ts and improve search functionality documentation
1 parent c04bc31 commit abe0c2f

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

rest/search.ts

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ export type SearchForPagesError =
2626
| NoQueryError
2727
| HTTPError;
2828

29-
/** search a project for pages
29+
/** Search for pages within a specific project
3030
*
31-
* @param query 検索語句
32-
* @param project 検索範囲とするprojectの名前
33-
* @param init connect.sid etc.
31+
* @param query The search query string to match against pages
32+
* @param project The name of the project to search within
33+
* @param init Options including connect.sid (session ID) and other configuration
3434
*/
3535
export const searchForPages = async (
3636
query: string,
@@ -69,10 +69,10 @@ export type SearchForJoinedProjectsError =
6969
| NoQueryError
7070
| HTTPError;
7171

72-
/** search for joined projects
72+
/** Search across all projects that the user has joined
7373
*
74-
* @param query 検索語句
75-
* @param init connect.sid etc.
74+
* @param query The search query string to match against projects
75+
* @param init Options including connect.sid (session ID) and other configuration
7676
*/
7777
export const searchForJoinedProjects = async (
7878
query: string,
@@ -110,15 +110,17 @@ export const searchForJoinedProjects = async (
110110

111111
export type SearchForWatchListError = SearchForJoinedProjectsError;
112112

113-
/** search for watch list
113+
/** Search within a list of watched projects
114114
*
115-
* watch listと銘打っているが、実際には参加していないpublic projectならどれでも検索できる
115+
* Note: Despite the name "watch list", this function can search any public project,
116+
* even those the user hasn't joined.
116117
*
117-
* 参加しているprojectのidは指定しても無視されるだけ
118+
* Note: If you include IDs of projects the user has already joined,
119+
* these IDs will be ignored in the search.
118120
*
119-
* @param query 検索語句
120-
* @param projectIds 検索候補のprojectのidのリスト
121-
* @param init connect.sid etc.
121+
* @param query The search query string to match
122+
* @param projectIds List of project IDs to search within (for non-joined public projects)
123+
* @param init Options including connect.sid (session ID) and other configuration
122124
*/
123125
export const searchForWatchList = async (
124126
query: string,

0 commit comments

Comments
 (0)