Emmanuel Lepage Vallee
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
Emmanuel Lepage Vallee
4bd90f0f35
doc: Add documentation linting and fix all issues it found.
2022-08-29 22:48:54 -07:00
Grumph
f6a2306d1a
Protect endswith and startswith from nil str
...
A nil parameter can mean an empty string (e.g. client.name), so we
just return false.
2021-01-26 17:58:25 +01:00
Yauhen Kirylau
37aa23be86
fix(gears: string: split): support more delimiters ( #2962 )
2020-01-19 19:04:28 -05:00
Seth Barberee
d05b7d80f1
gears.string doc revamp
2019-12-19 09:52:03 -06:00
Aire-One
82a2769e04
Fix ldoc modules summaries missing the final `.`.
2019-11-28 13:53:59 +01:00
Emmanuel Lepage Vallee
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
Emmanuel Lepage Vallee
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
Uli Schlachter
3927dbcf02
Fix incorrect @name annotation in gears.string
...
gears.string.xml_escape was annotated with "@name escape" and
gears.string.xml_unescape was annotated with "@name unescape".
Reference: https://github.com/awesomeWM/awesome/issues/2397#issuecomment-424630100
Signed-off-by: Uli Schlachter <psychon@znc.in>
2018-09-26 10:37:59 +02:00
Kevin Zander
5d0e9fd9e3
Add startswith and endswith function to gears.string, change awful.completion to use startswith over local function
2017-08-14 10:48:12 -05:00
romildo
894c254c42
Add string split function to gears.string
2017-03-20 20:20:36 -04:00
Kevin Zander
2f105eac86
Move string functions out of awful.util into new gears.string ( #1584 )
...
Update deprecated awful.util string function calls to gears.string calls
2017-03-11 18:57:32 -05:00