April Help about april-ann HOT 5 CLOSED

It is not a bug. april_help can't work with the given table. It needs to know the table name (as string) because the documentation is stored at an auxiliar table which replicates the hierarchy of namespaces and tables of April.

from april-ann.

Anyway, it would be very easy to improve april_help for dealing with tables:

if type(obj) == table then
print("Table ", #table)
for i, v in ipairs(table) do
print(i, v)
end
fi

isn't it? I don't know how determine if it is a pure table (integer indexes) or a dictionary...

from april-ann.

The obvious (and long) solution for that would be to iterate the values of the table and check if every entry is an integer. If some key is not an integer, then the table is a dictionary.

I don't know if there are more efficient solutions for that 🐵

from april-ann.

It is not as easy to deal with tables... the problem is that a table could be a lot of things.
april_help is designed to work with documented objects and structures of April. If you want a ipairs or pairs throught the table, it is simple, do it by yourself ;-) But the ipairs will not show documentation, only methods at the given table.

I mean, what you are asking is a different thing which has nothing to do with april_help. If you want, it is possible to add in "utils.lua" a simple function:

function print_table_pairs OR WHATEVER NAME(t) for i,v in pairs(t) do print(i,v) end

Bests.

from april-ann.

I forgot to explain one more thing. april_help leads with tables actually. But for other purposes. Look this example:

thenet = ann.components.stack()
april_help(thenet)

This piece of code shows the documentation associated with ann.components.stack. It is not the same as a pairs or ipairs, because the object has inheritance, and april_help goes through internal structure of April C++/Lua classes.

from april-ann.