Skip to content

Review and edit Lua docstrings#2717

Merged
daid merged 10 commits intodaid:masterfrom
oznogon:fix-script-docs
Mar 9, 2026
Merged

Review and edit Lua docstrings#2717
daid merged 10 commits intodaid:masterfrom
oznogon:fix-script-docs

Conversation

@oznogon
Copy link
Copy Markdown
Contributor

@oznogon oznogon commented Feb 13, 2026

  • Fix several examples that use a different function name than the one being documented (setSystemCoolant using setSystemPowerFactor, setPlanetAtmosphereTexture using setPlanetSurfaceTexture, several getters and setters mixed up)
  • Align examples of function usage to the arguments they actually use
  • Fix some incorrect defaults
  • Fix incorrect ship system heat, power, and health ranges
  • Remove extraneous arguments from getters (getHeading(0))
  • Remove extraneous colons from example function calls
  • Add missing docstring for VisualAsteroid
  • Add missing example to ModelData:setNormalMap
  • Flag setBeamFireSound/setBeamFireSoundPower as not implemented
  • Fix chaining order in ScanProbe example
  • Fix incorrect return type on getWaypointID
  • Fix incorrect scan state values in examples (full not fullscan)
  • Fix claim of case-insensitivity in ScienceDatabase set/getKeyValue, removeKey
  • Use "entity" or "ship" in place of legacy class names like SpaceObject or SpaceShip
  • Remove legacy class names in descriptions where they no longer apply
  • Remove duplicated onPickUp description and neutralize references to Artifacts and SupplyDrops
  • Remove manual angle behavior described in commandFireTube (needs verification)
  • Replace references to "meters" with "game units"
  • Fix several typos ("netural", "electical", "consideres", etc.)
  • Fix several references to incorrect source implementations (point to components/systems instead of spaceshipParts)

@oznogon oznogon marked this pull request as ready for review February 15, 2026 01:49
Comment thread scripts/api/entity/supplydrop.lua Outdated
Comment thread scripts/api/entity/supplydrop.lua Outdated
@oznogon oznogon requested a review from daid February 26, 2026 16:13
@daid daid merged commit 9dfa752 into daid:master Mar 9, 2026
5 checks passed
@oznogon oznogon deleted the fix-script-docs branch March 9, 2026 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants