doc: revisit gears.table #2538
doc: revisit gears.table #2538
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2538 +/- ##
=======================================
Coverage 84.56% 84.56%
=======================================
Files 497 497
Lines 33714 33714
=======================================
Hits 28511 28511
Misses 5203 5203
|
| -- @param item The item to look for in values of the table. | ||
| -- @return The key were the item is found, or nil if not found. | ||
| -- @treturn[1] string|number The key of the item. |
There was a problem hiding this comment.
according to your other PR numeric indexes shouldn't be used with @treturn? https://github.com/awesomeWM/awesome/pull/2537/files
There was a problem hiding this comment.
When used they refer to different return values / possibilities, i.e. here it will either return the key or nil.
There was a problem hiding this comment.
i see, thanks for explaining this
| --- Join all tables given as parameters. | ||
| -- This will iterate all tables and insert all their keys into a new table. | ||
| --- Join all tables given as arguments. | ||
| -- This will iterate over all tables and insert their entries into a new table. |
There was a problem hiding this comment.
shouldn't it be some word between all and tables? (https://blog.harwardcommunications.com/2016/11/17/how-to-use-all-whole-and-entire/)
There was a problem hiding this comment.
IMHO it is fine, but maybe "all of the tables"?
Maybe the original "iterate all tables" was fine already though?!
There was a problem hiding this comment.
judging from the article which i referenced above it could be ... all the tables ...
There was a problem hiding this comment.
"over all tables" is just as clear as "over all the tables".
There was a problem hiding this comment.
@Veratil
Thanks. This is my impression also.
Are you a native speaker?
There was a problem hiding this comment.
English is my only language sadly.
| -- @param args A list of tables to join | ||
| -- @return A new table containing all keys from the arguments. | ||
| -- @tparam table ... Tables to join. | ||
| -- @treturn table A new table containing all entries from the arguments. |
There was a problem hiding this comment.
all entries
the same comment as above and few more occurrences of the same pattern next on
No description provided.