mirrors/inspect.lua
1
0
Fork 0
mirror of https://github.com/TangentFoxy/inspect.lua.git synced 2025-07-28 02:52:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

<key>, <metatable> -> inspect.KEY, inspect.METATABLE

Browse Source
This commit is contained in:
kikito
2014-09-13 12:12:41 +02:00
parent 1fb5373a45
commit 9054ee1051
3 changed files with 26 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -139,10 +139,10 @@ local processed_item = function(item, path)
* `path` is an array-like table built with all the keys that have been used to reach `item`, from the root.
* For values, it is just a regular list of keys. For example, to reach the 1 in `{a = {b = 1}}`, the `path`
will be `{'a', 'b'}`
* For keys, a special value called `<key>` is inserted. For example, to reach the `c` in `{a = {b = {c = 1}}}`,
the path will be `{'a', 'b', 'c', '<key>' }`
* For metatables, a special value called `<metatable>` is inserted. For `{a = {b = 1}}}`, the path
`{'a', 'b', '<metatable>'}` means "the metatable of the table `{b = 1}`".
* For keys, the special value `inspect.KEY` is inserted. For example, to reach the `c` in `{a = {b = {c = 1}}}`,
the path will be `{'a', 'b', 'c', inspect.KEY }`
* For metatables, the special value `inspect.METATABLE` is inserted. For `{a = {b = 1}}}`, the path
`{'a', {b = 1}, inspect.METATABLE}` means "the metatable of the table `{b = 1}`".
* `processed_item` is the value returned by `options.process`. If it is equal to `item`, then the inspected
table will look unchanged. If it is different, then the table will look different; most notably, if it's `nil`,
the item will dissapear on the inspected table.