Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit985eb7b

Browse files
committed
Update docs
1 parenta0c2207 commit985eb7b

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

‎API.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
#acid.connections
22
low-level connection handler
33

4-
##`add(this, addr)`
4+
##`acid.connections.add(this, addr)`
55
Stores connection for reuse later
66

77
this**(table)**: Connections object.
88

99
addr**({string,string})**: Address tuple with ip and port.
1010

1111

12-
##`select(this, pwd, ix)`
12+
##`acid.connections.select(this, pwd, ix)`
1313
Elects selected connection as primary (thus default) for a certain address
1414

1515
this**(table)**: Connections object.
@@ -20,15 +20,15 @@ pwd **(string)**: path (usually project root).
2020
ix**(int)**: index of the stored connection
2121

2222

23-
##`unselect(this, pwd)`
23+
##`acid.connections.unselect(this, pwd)`
2424
Dissociates the connection for the given path
2525

2626
this**(table)**: Connections object.
2727

2828
pwd**(string)**: path (usually project root).
2929

3030

31-
##`get(this, pwd)`
31+
##`acid.connections.get(this, pwd)`
3232
Return active connection for the given path
3333

3434
this**(table)**: Connections object.
@@ -44,7 +44,7 @@ pwd **(string)**: path (usually project root).
4444
#acid.core
4545
low-level connection handler.
4646

47-
##`send([conn], obj, handler)`
47+
##`acid.core.send([conn], obj, handler)`
4848
Forward messages to the nrepl and registers the handler.
4949

5050
*conn***({string,string})**: Ip and Port tuple. Will try to get one if nil.
@@ -59,7 +59,7 @@ handler **(function)**: Handler function to deal with the response.
5959
#acid.features
6060
User-facing features and runnable commands
6161

62-
##`eval_cmdline(code[, ns])`
62+
##`acid.features.eval_cmdline(code[, ns])`
6363
Evaluate the given code and insert the result at the cursor position
6464

6565
code**(string)**: Clojure s-expression to be evaluated on the nrepl
@@ -68,7 +68,7 @@ code **(string)**: Clojure s-expression to be evaluated on the nrepl
6868
Defaults to current file's ns.
6969

7070

71-
##`eval_expr([mode[, ns]])`
71+
##`acid.features.eval_expr([mode[, ns]])`
7272
Evaluate the current form or the given motion.
7373

7474
*mode***(string)**: motion mode
@@ -77,7 +77,7 @@ Evaluate the current form or the given motion.
7777
Defaults to current file's ns.
7878

7979

80-
##`do_require([ns[, ...]])`
80+
##`acid.features.do_require([ns[, ...]])`
8181
Sends a`(require '[...])` function to the nrepl.
8282

8383
*ns***(string)**: Namespace to be used when evaluating the code.
@@ -86,15 +86,15 @@ Sends a `(require '[...])` function to the nrepl.
8686
*...*: extra arguments to the require function
8787

8888

89-
##`do_import(java_ns, symbols)`
89+
##`acid.features.do_import(java_ns, symbols)`
9090
Sends a`(import '[...])` function to the nrepl.
9191

9292
java_ns**(string)**: Namespace of the java symbols that are being imported.
9393

9494
symbols**({string,...})**: List of java symbols to be imported
9595

9696

97-
##`go_to([symbol[, ns]])`
97+
##`acid.features.go_to([symbol[, ns]])`
9898
Navigates the the definition of the given symbol.
9999

100100
*symbol***(string)**: Symbol to navigate to. Defaults to symbol under
@@ -104,7 +104,7 @@ Navigates the the definition of the given symbol.
104104
Defaults to current file's ns.
105105

106106

107-
##`docs([symbol[, ns]])`
107+
##`acid.features.docs([symbol[, ns]])`
108108
Shows the docstring of the given symbol.
109109

110110
*symbol***(string)**: Symbol which docs will be shown. Defaults to symbol under cursor.
@@ -113,29 +113,29 @@ Shows the docstring of the given symbol.
113113
Defaults to current file's ns.
114114

115115

116-
##`preload()`
116+
##`acid.features.preload()`
117117
Inject some clojure files into the nrepl sesion.
118118

119119

120-
##`load_all_nss()`
120+
##`acid.features.load_all_nss()`
121121
Load all namespaces in the current session.
122122

123123

124-
##`add_require(req)`
124+
##`acid.features.add_require(req)`
125125
Refactor the current file to include the given argument in the
126126
`(:requires ...)` section.
127127

128128
req**(string)**: require vector, such as`[clojure.string :as str]`.
129129

130130

131-
##`remove_require(req)`
131+
##`acid.features.remove_require(req)`
132132
Refactor the current file to remove the given argument from the
133133
`(:requires ...)` section.
134134

135135
req**(string)**: require namespace, such as`clojure.string`.
136136

137137

138-
##`sort_requires()`
138+
##`acid.features.sort_requires()`
139139
Refactor the current file so the`(:require ...)` form is sorted.
140140

141141

@@ -144,14 +144,14 @@ Refactor the current file so the `(:require ...)` form is sorted.
144144
#acid.forms
145145
Forms extraction
146146

147-
##`get_form_boundaries()`
147+
##`acid.forms.get_form_boundaries()`
148148
Returns the coordinates for the boundaries of the current form
149149

150150

151151
**(table)** coordinates {from = {row,col}, to = {row,col}}
152152

153153

154-
##`form_under_cursor()`
154+
##`acid.forms.form_under_cursor()`
155155
Extracts the innermost form under the cursor
156156

157157

@@ -160,7 +160,7 @@ Extracts the innermost form under the cursor
160160
**(table)** coordinates {from = {row,col}, to = {row,col}}
161161

162162

163-
##`symbol_under_cursor()`
163+
##`acid.forms.symbol_under_cursor()`
164164
Extracts the symbol under the cursor
165165

166166

@@ -174,7 +174,7 @@ Extracts the symbol under the cursor
174174
#acid
175175
Frontend module with most relevant functions
176176

177-
##`connected([pwd])`
177+
##`acid.connected([pwd])`
178178
Checks whether a connection exists for supplied path or not.
179179

180180
*pwd***(string)**: Path bound to connection.
@@ -184,15 +184,15 @@ Checks whether a connection exists for supplied path or not.
184184
**(boolean)** Whether a connection exists or not.
185185

186186

187-
##`run(cmd, conn)`
187+
##`acid.run(cmd, conn)`
188188
Façade to core.send
189189

190190
cmd: A command (op + payload + handler) to be executed.
191191

192192
conn: A connection where this command will be run.
193193

194194

195-
##`callback(session, ret)`
195+
##`acid.callback(session, ret)`
196196
Callback proxy for handling command responses
197197

198198
session: Session ID for matching response with request
@@ -221,7 +221,7 @@ Values:
221221
*`cider/cider-nrepl`
222222
*`refactor-nrepl`
223223

224-
##`start(obj)`
224+
##`acid.nrepl.start(obj)`
225225
Starts a tools.deps nrepl server
226226

227227
obj**(table)**: Configuration for the nrepl process to be spawn
@@ -237,7 +237,7 @@ Parameters for table `obj` are:
237237
**(boolean)** Whether it was possible to spawn a nrepl process
238238

239239

240-
##`stop(obj)`
240+
##`acid.nrepl.stop(obj)`
241241
Stops a nrepl process managed by acid
242242

243243
obj**(table)**: Configuration for the nrepl process to be stopped
@@ -246,7 +246,7 @@ Parameters for table `obj` are:
246246

247247
* obj.pwd**(string)**: Path where the nrepl process was started
248248

249-
##`show([ch])`
249+
##`acid.nrepl.show([ch])`
250250
Debugs nrepl connection by returning the captured output
251251

252252
*ch***(int)**: Neovim's job id of given nrepl process. When not supplied return all.

‎mdexport.lua‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ return {
4949
for_,fninipairs(mod.items)do
5050
print("")
5151
iffn['type']=='function'then
52-
print("## `"..fn.name..fn.args.."`")
52+
print("## `"..mod.name.."."..fn.name..fn.args.."`")
5353
iffn.summary~=nilthen
5454
print(fn.summary)
5555
print("")

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp