DreamWeave-MP / CoreScripts

The serverside Lua scripts used to implement core functionality in S3MP.
MIT License
0 stars 1 forks source link

Doc(clientVariableScopes): Experimental annotations for clientVariableScopes #33

Closed magicaldave closed 1 year ago

magicaldave commented 1 year ago

These ones I'm less confident in, I couldn't quite pin down how to document the table. I'm posting this one as a draft PR for review.

15

magicaldave commented 1 year ago

This one is ready, I think. :+1:

HotaruBlaze commented 1 year ago

It seems to be a mix of working and not working for me, my editor isn't liking the ? for some of the declarations, but the functions themselves look fine, though i wonder how much use this would end up being with all these annotations

STRING or STRING_BEGIN expected, got '?'

magicaldave commented 1 year ago

Would appreciate an additional chime on this one as stylistically I don't like placing the ? operator after the field name. Documentation says it should be type name, and this style breaks one of my editors. Further review is needed.