TeamREPENTOGON / REPENTOGON

Script extender for The Binding of Isaac: Repentance
https://repentogon.com/
GNU General Public License v2.0
115 stars 11 forks source link

Better Callback Documentation #435

Open Syntax-Sculptor opened 2 months ago

Syntax-Sculptor commented 2 months ago

While the callbacks page is a very useful resource for referencing what REPENTOGON has to offer, it has two faults:

jsgnextortex commented 2 months ago

I dont know if its appropiate to use the concept of a "dictionary" on lua where they dont really exist, dictionaries are just tables.

Syntax-Sculptor commented 2 months ago

I dont know if its appropiate to use the concept of a "dictionary" on lua where they dont really exist, dictionaries are just tables.

Yeah that's the tricky part right there. There's only a table data type but the way how it's returned should be more clear. Perhaps instead of specifying it as an "array" or "dictionary", maybe a code example for the callback could just speak for itself with what it expects to be returned?

jsgnextortex commented 2 months ago

We do those on the docs, the idea is that if someone needs extra information on callbacks they would go check there, if you mean adding more code examples there then, yea, they wouldnt hurt.

Sylmir commented 2 months ago

Indexed array vs. associative array ? Either way, examples should be there