Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add comments to what the scripted LUA functions do #56

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

EmosewaMC
Copy link
Contributor

@EmosewaMC EmosewaMC commented Dec 27, 2022

In an attempt to document the known LUA scripting functions, Ive used context clues and variable names to write some brief descriptions of what these functions do, what their parameters mean, and link to an example of where the function is used.

Also mac is amazing and slams .DS_Store files in directories so im ignoring those

@Xiphoseer
Copy link
Collaborator

I know this isn't the first PR that does it like that, but I'm generally not a fan of using the Line Blocks feature (lines starting with |) to emulate nested/structured lists if we don't need to. I'd prefer to use sth like Definition Lists, optionally with custom CSS if there's too much margin between lines or so.

For LUA specifically, I added

-e git+https://github.com/pieterlexis/sphinx-lua.git#egg=sphinx-lua
a while back, which isn't actually used yet and may make be even more useful (looks better, adds linkable heading ids)

@Xiphoseer
Copy link
Collaborator

Also mac is amazing and slams .DS_Store files in directories so im ignoring those

Yeah, opening a zip someone built on mac is always fun too 😄. I'm fine with merging this in here or as a separate PR.

@EmosewaMC EmosewaMC marked this pull request as draft August 22, 2023 21:04
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