Skip to content

Lua API doc improvements #1799

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

Merged
merged 1 commit into from
Oct 8, 2024
Merged

Lua API doc improvements #1799

merged 1 commit into from
Oct 8, 2024

Conversation

niksilver
Copy link
Contributor

  • Allow norns lua docs to use markdown.
  • Link Lua API documentation back to script references. For example, the API doc for the grid module now links back to https://monome.org/docs/norns/reference/grid, etc.
  • Remove ldoc warnings. It runs cleanly now.
  • Tidy up config.ld.
  • Correct module names in Lua API index.
  • Correct/Create @alias tags where needed.
  • List in docs for Screen.font_face() displays as a proper list.
  • List in docs fpr lib.lattice.new_socket() displays as a proper list.
  • Add link in lib.intonation.
  • Update readme-setup.md to explain how to install the docs, and that it should run without errors or warnings.

Generally this is an attempt to tidy up the Lua API docs. You should see no code changes here at all. Only comments have changed and config.ld has been updated.

An explanation about the "Correct module names" and "@alias" bullet points above. In the current API index page some of the module names display incorrectly. For example we see lib.BeatClock instead of lib.beatclock, and Lattice instead of lib.lattice. So these have now been corrected by applying @module and @alias tags correctly.

I notice that config.ld is set to process SuperCollider classes. I'm not aware that it runs over any SuperCollider classes, so those lines could be removed. But I've not removed them because I fear I'm missing something. Please do let me know if I've missed something here.

I realise these changes will not actually change the API docs on the website. That's because this needs to be copied manually into another repo. I will do that as a separate piece of work - perhaps with some further improvements there. However, I want to make sure these changes are accepted first, before I think about copying them over.

* Allow norns lua docs to use markdown.
* Link Lua API documentation back to script references.
* Remove most ldoc warnings.
* Correct config.ld to remove ldoc failure.
* Correct module names in Lua API index.
* Correct/Create @alias tags where needed.
* Improve list in Screen.font_face().
* Improve list in documentation of lib.lattice.new_socket().
* Add link in lib.intonation.
* Update readme-setup.md to explain how to install the docs.
@tehn
Copy link
Member

tehn commented Oct 8, 2024

looks great! will do a full review very soon. thank you.

Copy link
Member

@tehn tehn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, these are all great improvements!

I can copy the html over to the main site.

@tehn tehn merged commit 1ecd424 into monome:main Oct 8, 2024
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