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

Document utils.execute in utils.lua #479

Merged
merged 1 commit into from
Jun 11, 2024

Conversation

jlaurens
Copy link
Contributor

@jlaurens jlaurens commented Jun 9, 2024

Document utils.execute function referred to in quote_arg documentation.
BEWARE: this is not tested because I cannot build locally the whole documentation.

@Tieske
Copy link
Member

Tieske commented Jun 10, 2024

this is a bit tricky, since all of compat is imported. So if we document this one, we'd need to document them all. Which then becomes cumbersome, since we'd need to update descriptions in multiple places.

@Tieske
Copy link
Member

Tieske commented Jun 10, 2024

@jlaurens
Copy link
Contributor Author

Well, we do not really need to document absolutely everything, only what is really used in the doc. The online documentation of quote_arg reads

Quotes a single (or list of) argument(s) of a command to be passed to os.execute, pl.utils.execute or pl.utils.executeex.

os.execute is a link as well as pl.utils.executeex, but not pl.utils.execute. Finding documentation for it is quite impossible for the average people. I myself digged into the sources and found the lines that you mentioned above. But this is not really what one would expect from an efficient documentation.

Copy link
Member

@Tieske Tieske left a comment

Choose a reason for hiding this comment

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

This should move down into the same @section as the other execute related functions.

lua/pl/utils.lua Outdated Show resolved Hide resolved
@Tieske Tieske merged commit f3d8e99 into lunarmodules:master Jun 11, 2024
8 checks passed
@jlaurens jlaurens deleted the utils_execute branch June 11, 2024 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants