scp-fs2open / scp-fs2open/fs2open.github.com

LUA API documentation is lacking

Open
#4,109 5 comments 1 reaction 0 assignees View on GitHub
cleanup documentation scripting
Dominant language
C++
Stars
487
Forks
184
Avg merge
3d 9h
Merged PRs (30d)
44

Description

Having FSO output the scripting.html is a novel idea to keep modders up to date on what functions they have access to, but to be honest the result is very user unfriendly and everything isn't documented adequately.

One particular example is that the numerous Enumerations at the bottom of the scripting.html have no information on what exactly they do, or for that matter suggest some of the precautions a modder has to take in order for them to work correctly. This let to issues such as #4108 to occur

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.