Skip to content

Commit d8e4afa

Browse files
CFrankCFrank
authored andcommitted
fix some missing return tags in notepad.rst
1 parent 6928ddf commit d8e4afa

1 file changed

Lines changed: 25 additions & 24 deletions

File tree

docs/source/notepad.rst

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ Notepad++ Object
2626
*view* is 0 or 1.
2727

2828

29-
.. method:: notepad.allocateCmdID(numberRequested)
29+
.. method:: notepad.allocateCmdID(numberRequested) -> int
3030

3131
Allocates a range of Command ID for use in WM_COMMAND. Mainly used internally by plugins.
3232

3333
Returns:
3434
The start number of the requested range
3535

36-
.. method:: notepad.allocateMarker(numberRequested)
36+
.. method:: notepad.allocateMarker(numberRequested) -> bool
3737

3838
Allocates a range of marker number for Scintilla.
3939
Use this to stop marker number collisions with other plugins / scripts.
@@ -42,7 +42,7 @@ Notepad++ Object
4242
The start number of the requested range
4343

4444

45-
.. method:: notepad.allocateSupported()
45+
.. method:: notepad.allocateSupported() -> bool
4646

4747
Returns True if the Command ID allocation API is supported in this version of Notepad++
4848

@@ -67,7 +67,7 @@ Notepad++ Object
6767
then import that module in the script that calls ``notepad.callback()``. This way
6868
you can unregister the callback easily.
6969

70-
For Scintilla notifications, see ``editor.callback()``
70+
For Scintilla notifications, see ``editor.callback()`` -> bool
7171

7272
Returns:
7373
``True`` if the registration was successful
@@ -112,12 +112,12 @@ Notepad++ Object
112112

113113
Closes all but the currently active document
114114

115-
.. method:: notepad.createScintilla()
115+
.. method:: notepad.createScintilla() -> editor
116116

117117
Create a new Scintilla handle. Returns an Editor object
118118

119119

120-
.. method:: notepad.decodeSci(view)
120+
.. method:: notepad.decodeSci(view) -> int
121121

122122
View is either 0 or 1
123123
Returns the old unicodeMode
@@ -138,7 +138,7 @@ Notepad++ Object
138138
True if it should be hidden, False if it should be shown
139139

140140

141-
.. method:: notepad.encodeSci(view)
141+
.. method:: notepad.encodeSci(view) -> int
142142

143143
View is either 0 or 1
144144
Returns the new unicodeMode
@@ -149,7 +149,7 @@ Notepad++ Object
149149
Flashes notepad++ for the given count and milliseconds
150150

151151

152-
.. method:: notepad.getAppdataPluginsAllowed()
152+
.. method:: notepad.getAppdataPluginsAllowed() -> bool
153153

154154
Returns True if loading plugins from %APPDATA%\Notepad++\plugins is allowed, False otherwise
155155

@@ -179,15 +179,15 @@ Notepad++ Object
179179
Gets the filename of the active document
180180

181181

182-
.. method:: notepad.getCurrentLang()
182+
.. method:: notepad.getCurrentLang() -> LANGTYPE
183183

184184
Get the current language type
185185

186186
Returns:
187187
:class:`LANGTYPE`
188188

189189

190-
.. method:: notepad.getCurrentNativeLangEncoding()
190+
.. method:: notepad.getCurrentNativeLangEncoding() -> int
191191

192192
Returns the current native language encoding
193193

@@ -197,12 +197,12 @@ Notepad++ Object
197197
Get the currently active view (0 or 1)
198198

199199

200-
.. method:: notepad.getEditorDefaultBackgroundColor()
200+
.. method:: notepad.getEditorDefaultBackgroundColor() -> tuple
201201

202202
Returns the default background color as tuple
203203

204204

205-
.. method:: notepad.getEditorDefaultForegroundColor()
205+
.. method:: notepad.getEditorDefaultForegroundColor() -> tuple
206206

207207
Returns the default foreground color as tuple
208208

@@ -220,7 +220,7 @@ Notepad++ Object
220220
:class:`BUFFERENCODING`
221221

222222

223-
.. method:: notepad.getFiles()
223+
.. method:: notepad.getFiles() -> list
224224

225225
Gets a list of the open filenames.
226226

@@ -237,12 +237,12 @@ Notepad++ Object
237237
:class:`FORMATTYPE`
238238

239239

240-
.. method:: notepad.getLanguageDesc(langType)
240+
.. method:: notepad.getLanguageDesc(langType) -> LANGTYPE
241241

242242
Returns the programming language short description from the given :class:`LANGTYPE`
243243

244244

245-
.. method:: notepad.getLanguageName(langType)
245+
.. method:: notepad.getLanguageName(langType) -> LANGTYPE
246246

247247
Returns the programming language name from the given :class:`LANGTYPE`
248248

@@ -263,11 +263,12 @@ Notepad++ Object
263263

264264
.. method:: notepad.getMenuHandle(menu)
265265

266-
Menu is either 0(main) or 1(plugin)
266+
Menu is either 0(main) or 1(plugin) -> int
267+
267268
Returns the handle for the main or plugins menu.
268269

269270

270-
.. method:: notepad.getNbUserLang()
271+
.. method:: notepad.getNbUserLang() -> int
271272

272273
Returns the number of user defined languages
273274

@@ -287,7 +288,7 @@ Notepad++ Object
287288
Gets the PythonScript plugin version as a string. There is always four parts to it. e.g. '0.9.2.0'
288289

289290

290-
.. method:: notepad.getSessionFiles(sessionFileName)
291+
.. method:: notepad.getSessionFiles(sessionFileName) -> list
291292

292293
Returns a list of files from given session file
293294

@@ -297,7 +298,7 @@ Notepad++ Object
297298
Gets the Notepad++ version as a tuple - e.g. 5.6.8 becomes ``(5,6,8)``
298299

299300

300-
.. method:: notepad.getWindowsVersion()
301+
.. method:: notepad.getWindowsVersion() -> WINVER
301302

302303
Returns current windows version :class:`WINVER`
303304

@@ -322,12 +323,12 @@ Notepad++ Object
322323
True if it should be hidden, False if it should be shown
323324

324325

325-
.. method:: notepad.isDocSwitcherShown()
326+
.. method:: notepad.isDocSwitcherShown() -> bool
326327

327328
Returns True if document switcher is shown else False
328329

329330

330-
.. method:: notepad.isMenuHidden()
331+
.. method:: notepad.isMenuHidden() -> bool
331332

332333
Returns True if menu is hidden else False
333334

@@ -337,17 +338,17 @@ Notepad++ Object
337338
True if only one view is used, False otherwise
338339

339340

340-
.. method:: notepad.isStatusBarHidden()
341+
.. method:: notepad.isStatusBarHidden() -> bool
341342

342343
Returns True if statusbar is hidden else False
343344

344345

345-
.. method:: notepad.isTabBarHidden()
346+
.. method:: notepad.isTabBarHidden() -> bool
346347

347348
Returns True if tabbar is hidden else False
348349

349350

350-
.. method:: notepad.isToolBarHidden()
351+
.. method:: notepad.isToolBarHidden() -> bool
351352

352353
Returns True if toolbar is hidden else False
353354

0 commit comments

Comments
 (0)