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.

Sign up for GitHub

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

Jump to bottom

Add information about the availability to each module in the API docs #61

Open
rdw-software opened this issue Feb 4, 2023 · 0 comments
Open

Add information about the availability to each module in the API docs #61

rdw-software opened this issue Feb 4, 2023 · 0 comments

Comments

@rdw-software
Copy link
Member

Example:

<Module name="bdd" availability="preloaded"/>

Should automatically include how the module can be accessed:

  • Preloaded packages can be used via local lib = require("lib")
  • Globals are available via _G.lib or just lib
  • Namespaced packages are available in their respective namespace (TBD)

There should probably some docs for this in the docs, as well... (References > Documentation > Components > Module)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rdw-software