Docs for events

[gsmj]

• added all event docs from open.mp

[gsmj]

looks fine

[dennorske]

I am also wondering if we should not document the inner callbacks for the events - Ideally we should document these as proper events. Maybe we can somehow tell sphinx that we want them to be annotated as events and not as classmethods? Wondering if you have some experience with this @Cheaterman

[Cheaterman]

Great question! I haven't done that in the past, but from a quick glance at Sphinx docs, the way to achieve this might be to develop a autodoc extension that will apply some special behavior to our @event decorator ; I'll ask on IRC and see if it's the right call :-)

[Cheaterman]

Another small detail I mentioned on Discord but will repost here - it's probably a good idea to document which SAMP/open.mp callback is being wrapped by each event, and provide a link to the corresponding open.mp documentation ; the first part so that people coming from Pawn can be 100% sure which event corresponds to the callback they're looking for, and the second part in case eg open.mp adds extra warnings or behavior changes to the official documentation (I don't think we'll be keeping it in sync constantly, probably too much maintenance burden).

[dennorske]

I approve the changes and I think they are valuable to get in to our documentation as a "for now they are good enough" kind of deal.

Thank you very much @gsmj !

I however want us to clarify and label the events properly via sphinx, so we will have to follow up on that later.