Skip to content

Commit fdf0cd7

Browse files
committed
Updated readme
1 parent a635100 commit fdf0cd7

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,15 +102,24 @@ Settings are located in *Preferences* > *Package Settings* > *SublimePapyrus*.
102102
Syntax highlighting for the version of Papyrus that is used in ***The Elder Scrolls V: Skyrim***.
103103

104104
#### Linter
105+
Requirements:
106+
- The linter has to be enabled in the settings.
107+
- The script that is being edited to have been saved as a file.
108+
105109
The linter performs lexical, syntactic, and semantic analysis on the source code of scripts as they are being edited. Lines that cause errors are highlighted and the error messages are shown as status messages (bottom left corner of Sublime Text).
106110

107-
Caching is used by the linter in order to improve performance and cache invalidation only exists for a few scenarios. Modifications to the import folders setting (e.g. changing the order of paths) requires a restart of Sublime Text in order to clear the cache and ensure that the right scripts are being used.
111+
Caching is used by the linter in order to improve performance and cache invalidation only occurs in a few scenarios. Modifications to the import folders setting (e.g. changing the order of paths) requires a restart of Sublime Text in order to clear the cache and ensure that the right scripts are being used.
108112

109113
The linter does work in Sublime Text 2, but error messages and highlighting is not possible due to technical limitations, which do not apply to Sublime Text 3, regarding the API in Sublime Text 2 when the linter is triggered by editing a script. Error messages and highlighting is possible in Sublime Text 2 when the linter is triggered by saving a script.
110114

111115
Information about settings relevant to the linter can be found **[here](#settings)**.
112116

113117
#### Intelligent code completion
118+
Requirements:
119+
- The system has to be enabled in the settings.
120+
- The same requirements as in the case of the linter.
121+
- The script has to have been processed by the linter.
122+
114123
The intelligent code completion system utilizes the linter to produce suggestions in a context-aware manner. This system can:
115124
- Return completions for all functions, events, properties, and variables (including function/event parameters) that exist within the scope of the line that is being edited. This includes functions, events, and properties that have been inherited from a parent script, if a parent script has been defined.
116125

@@ -168,6 +177,9 @@ Single file build system and a batch build variant.
168177
- SKSE mod event names
169178

170179
## **Changelog**
180+
Version 1.0.6 - 2016/03/09:
181+
- Fixed an issue that produced incorrect completions for array parameters in function and event completions.
182+
171183
Version 1.0.5 - 2016/03/08:
172184
- Fixed string literal regex in the linter.
173185

0 commit comments

Comments
 (0)