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

[Docs] Fix GetUnitWeaponState

Open
#2,161 2 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

Format it into something more usable for the emmylua annotations and docgen. Source: https://github.com/beyond-all-reason/spring/blob/3003a30f988ce7c13c0060f108a69efd383996da/rts/Lua/LuaSyncedRead.cpp#L5112-L5143

In particular use either an `alias` for the param argument or some way to indicate its a name of a field in the `WeaponState` class (as long as that's true, engine might be quirky sometimes).

Make sure to check the list of params is up-to-date and describe better or add when necessary

Contributor guide

Open the contributing guide

Research direction

Read the GetUnitWeaponState implementation in rts/Lua/LuaSyncedRead.cpp at lines 5112-5143, then locate its emmylua annotation and docgen representation. Compare the documented parameter list with the implementation and WeaponState fields, and finish when the parameter naming or aliasing and descriptions are usable and up to date.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.