rhys-vdw / rhys-vdw/lua-doc-extractor

Source link is appended before full description is concatenated

Open
#40 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2
Forks
3
Avg merge
2m
Merged PRs (30d)
1

Description

/***
 * @function Spring.SetUnitHealth
 *
 * Note, if your game's custom shading framework doesn't support reverting into nanoframes
 * then reverting into nanoframes via the "build" tag will fail to render properly.
 *
 * @param unitID integer
 * @param health number|SetUnitHealthAmounts If a number, sets the units health
 * to that value. Pass a table to update health, capture progress, paralyze
 * damage, and build progress.
 * @return nil
 * 
 * @see SetUnitHealthAmounts
 */
int LuaSyncedCtrl::SetUnitHealth(lua_State* L)
---[<a href="https://github.com/beyond-all-reason/spring/blob/0e02c56c8dc282deed3d4706bb6d392ba437e0d6/rts/Lua/LuaSyncedCtrl.cpp#L2086-L2099" target="_blank">source</a>]
---
---Note, if your game's custom shading framework doesn't support reverting into nanoframes
---then reverting into nanoframes via the "build" tag will fail to render properly.
---
---@param unitID integer
---@param health number|SetUnitHealthAmounts If a number, sets the units health
---to that value. Pass a table to update health, capture progress, paralyze
---damage, and build progress.
---@return nil
---@see SetUnitHealthAmounts
function Spring.SetUnitHealth(unitID, health) end

Because the @function renderer runs after the source link is added.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the @function renderer and the code path that adds the source link, using the SetUnitHealth example in the issue to reproduce the ordering. Done means the full description is concatenated before the source link is appended, with the rendered output matching that order.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, typescript
Domain
documentation, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.