86d1b1c22c
doc: Add a mandatory `@noreturn` for functions and methods.
...
The goal is to catch cases where the return value exists, but is
forgotten. There was a large enough number of them to turn this
into a real check. Initially, I just wanted to implement it to fix
the problems, then delete the code. But since this is so common, I
think it is worth the annoyance.
2022-08-29 22:49:45 -07:00
4bd90f0f35
doc: Add documentation linting and fix all issues it found.
2022-08-29 22:48:54 -07:00
e0b982fa1a
gears.debug: Use the API level as the source of truth.
...
Rather than the version.
2020-02-08 17:18:01 -05:00
da8daa8dfc
debug: Allow "deprecated_in" for class deprecation.
2020-01-19 01:55:51 -05:00
a6e52a8c42
doc: Fix an incorrect signal name. ( #2943 )
...
Reported by @unai-ndz
See #1373
2019-12-11 10:01:54 -08:00
b4ece0f053
doc: Use an explicit tag for all static functions.
...
This way their name doesn't get mangle by the broken magic. It will also
eventually allow to `error()` in the template when the implicit
`@function` is used.
This commit also fixes a large number of issues found while
proof-reading everything.
2019-06-08 18:14:13 -04:00
ded35502d5
doc: Add a section for utility libraries
...
Dedicated for the modules extensions developers will need, but that the
general "I only edit rc.lua" user wont.
2019-06-08 18:13:42 -04:00
68497dffc4
gears.debug.print_{warning_error}: add "awesome: " prefix ( #1968 )
...
This makes it consistent with the C functions (`_warn` and `_fatal`).
2017-08-10 14:08:32 +02:00
1f8b07d475
debug: Add a signal for deprecation warnings ( #1832 )
...
Fixes #1612 .
2017-06-21 02:06:32 +02:00
7687275607
Move awful.util.deprecate and awful.util.deprecate_class to gears.debug
...
Change all awful.util function calls to gears.debug function calls
Update all old deprecate calls to have deprecated_in=4
2017-03-15 20:08:22 -05:00
259c4f716f
Remove @release @AWESOME_VERSION@ everywhere ( #1157 )
...
It does not provide much value. The version number is already known to
ldoc globally in the "description" variable.
Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-10-09 22:36:20 +02:00
2ad49dfd0c
Fix some broken documentation in gears.debug
...
Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-02-28 12:05:55 +01:00
8c26e2dab4
Fix all luacheck warnings in lib/gears
...
Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-02-12 09:11:50 +01:00
720cd879f3
Add timestamps to messages on stderr ( #602 )
...
Closes https://github.com/awesomeWM/awesome/pull/606 .
Fixes https://github.com/awesomeWM/awesome/issues/602 .
Signed-off-by: Uli Schlachter <psychon@znc.in>
2015-12-31 15:38:17 +01:00
14be909206
Remove gears.debug.assert
...
Lua provides an assert() function already, so let's just use that.
Signed-off-by: Uli Schlachter <psychon@znc.in>
2015-09-16 15:01:26 +02:00
09dce08fd4
gears.debug: add support for limited depth
...
This is useful with big tables and might even be necessary to prevent
infinite recursion.
To prevent the latter, the default is 10.
This adds an indicator when `depth` is reached for tables.
awesome# return require("gears").debug.dump_return(t4, "", 2)
string " : table: 0x1580130
1 : table: 0x16951d0
1 : wibox.widget.base (table) […]
2 : wibox.widget.base (table) […]
3 : 4 (number)
4 : 5 (number)
5 : foo (string)
2 : table: 0x16ac790
1 : table: 0x16951d0 (table) […]
3 : table: 0x16cc500
1 : table: 0x16951d0 (table) […]
2 : table: 0x16ac790 (table) […]"
awesome# return require("gears").debug.dump_return(t4, "", 1)
string " : table: 0x1580130
1 : table: 0x16951d0 (table) […]
2 : table: 0x16ac790 (table) […]
3 : table: 0x16cc500 (table) […]"
Closes https://github.com/awesomeWM/awesome/pull/372 .
2015-08-01 11:24:35 +02:00
6cc7be512c
Remove the *.in from all files.
...
Signed-off-b: Julian Wollrath <jwollrath@web.de>
2015-06-19 22:33:32 +02:00
Emmanuel Lepage Vallee
Daniel Hahler
Kevin Zander
Uli Schlachter
Uli Schlachter
Daniel Hahler
Julian Wollrath