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

Add empty space below multi-line param description

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

Nobody has claimed this yet.

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

Description

---@class ShaderParams
---@field vertex? string
---
---The "Vetex" or vertex-shader is your GLSL-Code as string, its written in a
---C-Dialect.  This shader is busy deforming the geometry of a unit but it can
---not create new polygons. Use it for waves, wobbling surfaces etc.
---@field tcs? string glsl code
---
---The "TCS" or Tesselation Control Shader controls how much tessellation a
---particular patch gets; it also defines the size of a patch, thus allowing it
---to augment data. It can also filter vertex data taken from the vertex shader.
---The main purpose of the TCS is to feed the tessellation levels to the
---Tessellation primitive generator stage, as well as to feed patch data (as its
---output values) to the Tessellation Evaluation Shader stage.
---@field tes? string glsl code

Looks bad

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

Use the Lua snippet in the issue as a reproduction and trace the parser or renderer that handles multiline @field descriptions. Compare its generated documentation with the current output; done means an empty line appears below each multiline parameter description without affecting adjacent fields.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, typescript
Domain
documentation, tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.