Skip to content

Conversation

badosu
Copy link
Collaborator

@badosu badosu commented Jul 15, 2025

  • Update emmylua that now has fixed @see
  • Leverage the new custom tag logic
  • Fix ref matching breaking layout
  • Migrate custom tags from @custom to @x_custom
  • A bunch of layout improvements
  • Random doc fixes

Available at https://badosu.github.io/RecoilEngine/docs/lua-api/

badosu added 3 commits July 14, 2025 23:30
- Update emmylua that now has fixed @see
- Leverage the new custom tag logic
- Fix ref matching breaking layout
- Migrate custom tags from @Custom to @x_custom
- A bunch of layout improvements
- Random doc fixes
@badosu
Copy link
Collaborator Author

badosu commented Jul 15, 2025

ref not parsed on alias ResourceUsage

swappy-20250715_115100

@badosu
Copy link
Collaborator Author

badosu commented Jul 15, 2025

Remove intermediary aliases, these don't render well. E.g. instead of @alias xyz float3 -> @alias xyz actual_type

@sprunk
Copy link
Collaborator

sprunk commented Jul 15, 2025

With RGB(A) it should also specify whether there's color bit depth involved or not, i.e. is the value for a fully saturated colour channel 255, or 1.0? (It's mostly 1.0 but IIRC there may have been one or two interfaces where it's 255)

@sprunk
Copy link
Collaborator

sprunk commented Jul 15, 2025

This one has a weird blue section and a bunch of what I think are empty 0-size sections (marked with arrows) but I expect this is just those specific entries having screwed up formatting rather than any issue with emmylua/parsing.
image

@badosu
Copy link
Collaborator Author

badosu commented Jul 15, 2025

With RGB(A) it should also specify whether there's color bit depth involved or not, i.e. is the value for a fully saturated colour channel 255, or 1.0? (It's mostly 1.0 but IIRC there may have been one or two interfaces where it's 255)

I agree, aliases can't receive documentation afaik, so we'd have to make it a @x_helper @table or @class

@sprunk
Copy link
Collaborator

sprunk commented Jul 15, 2025

Code section seems to sometimes flatten newlines and produce zero-size sections:

image

Should be

textures
├── texture1.png
├── texture2.png
└── texture3.png
models
└── model1.mdl

Another example

image

@badosu
Copy link
Collaborator Author

badosu commented Jul 15, 2025

This one has a weird blue section and a bunch of what I think are empty 0-size sections (marked with arrows) but I expect this is just those specific entries having screwed up formatting rather than any issue with emmylua/parsing

Thank you, I think I know how to resolve this.

@badosu
Copy link
Collaborator Author

badosu commented Jul 15, 2025

Code section seems to sometimes flatten newlines and produce zero-size sections:
...

Should be

textures
├── texture1.png
├── texture2.png
└── texture3.png
models
└── model1.mdl

Gotcha, all these are similar, related to how we send markdown to hugo from source and parsing refs. You don't need to add more issues related to codeblocks (although single backtick codeblocks yes!)

@sprunk
Copy link
Collaborator

sprunk commented Jul 15, 2025

Syntax coloring is somewhat poor:

  • the nil return is colored but the boolean or string returns are not (I guess it's because it's implicit? Shouldn't matter though)
  • most words are still white, harder to tell the function name and the args apart
  • the ? is a bit hard to see. This is on light mode, it gets a bit better with dark mode
  • optionally it would be nice if custom types e.g. RmlUI.Context were clickable, though they're already clickable in the extended params list just below so if it's not trivial it's probably not worth bothering.
image

@badosu
Copy link
Collaborator Author

badosu commented Jul 15, 2025

Syntax coloring is somewhat poor:

  • the nil return is colored but the boolean or string returns are not (I guess it's because it's implicit? Shouldn't matter though)
  • most words are still white, harder to tell the function name and the args apart
  • the ? is a bit hard to see. This is on light mode, it gets a bit better with dark mode

...

image

This one would require making a syntax highlighting or syntax scheme that is optimal for our purposes, I consider it out of the scope for this PR specifically, but it deems a separate issue for sure. I welcome additional suggestions on this issue

  • optionally it would be nice if custom types e.g. RmlUI.Context were clickable, though they're already clickable in the extended params list just below so if it's not trivial it's probably not worth bothering.

This one is feasible, I'll see if it's easy to get done.

@badosu
Copy link
Collaborator Author

badosu commented Jul 22, 2025

As soon as the new release is available there will be a regression on the rendering of some type literals, see EmmyLuaLs/emmylua-analyzer-rust#653.

Still, the possibility of properly sectioning and separating environments will be enough of an improvement to push forward, a few regressions are expected to happen until we reach a stable middle ground.

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