Skip to content

Commit cb95ab8

Browse files
committed
Updated API documentation.
1 parent d2bb1b4 commit cb95ab8

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ ta = ../..
66
cwd = $(shell pwd)
77
docs: README.md
88
README.md: init.lua
9-
cd $(ta)/scripts && ldoc --filter markdowndoc.ldoc $(cwd)/$< > $(cwd)/$@
10-
sed -i -e '1,+4d' -e '6c# Open File Mode' -e '7d' -e 's/^##/#/;' $@
9+
cd $(ta)/scripts && ldoc --filter markdowndoc.ldoc $(cwd)/$< -- --title="Open File Mode" \
10+
--single > $(cwd)/$@
1111

1212
# Releases.
1313

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
11
# Open File Mode
2-
---
32

43
A Textadept module that extends the editor's `ui.command_entry` with a mode that can open
54
files relative to the current file or directory.
5+
66
Tab-completion is available.
77

88
This is an alternative to Textadept's default File Open dialog.
99

1010
Install this module by copying it into your *~/.textadept/modules/* directory or Textadept's
1111
*modules/* directory, and then putting the following in your *~/.textadept/init.lua*:
1212

13-
keys['alt+o'] = require('open_file_mode')
13+
```lua
14+
keys['alt+o'] = require('open_file_mode')
15+
```
1416

1517
Replace "alt+o" with the key you want to bind the function to. You can also create a menu
1618
item with that function.
1719

18-
## Functions defined by `ui.command_entry.open_file`
19-
2020
<a id="_G.ui.command_entry.open_file"></a>
21-
### `_G.ui.command_entry.open_file`()
21+
## `_G.ui.command_entry.open_file`()
2222

2323
Opens the command entry in a mode that can open files relative to the current file or
2424
directory.
25+
2526
Tab-completion is available, and on Windows, Cygwin-style '/c/' root directories are supported.
2627
If no file is ultimately specified, the user is prompted with Textadept's default File
2728
Open dialog.
2829

2930

30-
---
31+

init.lua

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
-- Install this module by copying it into your *~/.textadept/modules/* directory or Textadept's
1010
-- *modules/* directory, and then putting the following in your *~/.textadept/init.lua*:
1111
--
12-
-- keys['alt+o'] = require('open_file_mode')
12+
-- ```lua
13+
-- keys['alt+o'] = require('open_file_mode')
14+
-- ```
1315
--
1416
-- Replace "alt+o" with the key you want to bind the function to. You can also create a menu
1517
-- item with that function.

0 commit comments

Comments
 (0)