Page MenuHomePhabricator

Improve developer manual for scripting interface in Huggle
Open, Needs TriagePublic

Description

In huggle Scripting -> Show scripting manual displays overview compiled from built-in function descriptions in Huggle. This manual is terrible, I made scripting interface and still find it hard to understand how to use it using just this manual, without looking into actual underlying C++ code.

We need to:

  • show return type of every function
  • expand short descriptions - there must be explanation what exactly does the function do
  • implement long descriptions
  • provide examples

Event Timeline