beyond-all-reason / beyond-all-reason/RecoilEngine

Fix sections in site lua api listings

Open
#1,204 0 comments 0 reactions 0 assignees View on GitHub
area: documentation good first issue
Dominant language
C++
Stars
679
Forks
290
Avg merge
3d 2h
Merged PRs (30d)
40

Description

Some functions in [our API listings](https://beyond-all-reason.github.io/spring/ldoc/modules/UnsyncedCtrl.html) belong to incorrect sections.

For example `Spring.Quit` is listed under the "Engine Config" section while all other similar functions (`Spring.Reload`, `Spring.Restart`, `Spring.Start`) are in the "Misc" section. So `Spring.Quit` should be moved to "Misc" somehow.

The full task ultimately involves putting all functions in appropriate sections, but most of the work is figuring out how to do that without moving whole implementations around the file. A quick googling suggest that `@within ` exists so it may be as simple as adding that one line to each mis-sectioned function. Once an example exists and works it will be easy to copy-paste.

Contributor guide

Open the contributing guide

Research direction

Start with the UnsyncedCtrl API listing linked in the issue and compare each function with similar functions in the intended sections. Check whether adding an @within annotation changes the generated listing, using Spring.Quit as the example; done means all functions appear in appropriate sections without moving whole implementations.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.