aboutsummaryrefslogtreecommitdiff
path: root/core/init.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-10-29 20:45:58 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2012-10-29 20:45:58 -0400
commitfa38d2306fadc99bb1403433517ecf45a24062eb (patch)
tree19f286adb6be4cbd7a1b11fc1c880976a01ea9fd /core/init.lua
parent6718de08a3f19f8c24c1c4167b05828a7ac0dfd7 (diff)
downloadtextadept-fa38d2306fadc99bb1403433517ecf45a24062eb.tar.gz
textadept-fa38d2306fadc99bb1403433517ecf45a24062eb.zip
Updated documentation formatting.
Pathnames and filenames are italic and be more consistent with constant width text.
Diffstat (limited to 'core/init.lua')
-rw-r--r--core/init.lua14
1 files changed, 7 insertions, 7 deletions
diff --git a/core/init.lua b/core/init.lua
index a0da9f94..a8cd48d6 100644
--- a/core/init.lua
+++ b/core/init.lua
@@ -31,13 +31,13 @@ _M = {} -- modules table
-- @field _RELEASE (string)
-- The Textadept release version.
-- @field _USERHOME (string)
--- Path to the user's `~/.textadept/`, where all preferences and user-data is
+-- Path to the user's *~/.textadept/*, where all preferences and user-data is
-- stored.
--- On Windows machines `~/` is the value of the `USERHOME` environment
--- variable, typically `C:\Users\<username>\` or
--- `C:\Documents and Settings\<username>\`. On Linux, BSD, and Mac OSX
--- machines `~/` is the value of `HOME`, typically `/home/<username>/` and
--- `/Users/<username>/` respectively.
+-- On Windows machines *~/* is the value of the "USERHOME" environment
+-- variable, typically *C:\Users\username\\* or
+-- *C:\Documents and Settings\username\\*. On Linux, BSD, and Mac OSX
+-- machines *~/* is the value of "$HOME", typically */home/username/* and
+-- */Users/username/* respectively.
-- @field _CHARSET (string)
-- The character set encoding of the filesystem.
-- This is used when [working with files](io.html).
@@ -115,7 +115,7 @@ local quit
-- Language-specific modules for opened files are NOT reloaded. Re-opening the
-- files that use them will reload those modules instead.
-- This function is useful for modifying user scripts (such as
--- `~/.textadept/init.lua` and `~/.textadept/modules/textadept/keys.lua`) on
+-- *~/.textadept/init.lua* and *~/.textadept/modules/textadept/keys.lua*) on
-- the fly without having to restart Textadept. `_G.RESETTING` is set to `true`
-- when re-initing the Lua State. Any scripts that need to differentiate between
-- startup and reset can utilize this variable.