tarantool / tarantool/doc

feedback: Other package components | Tarantool

Open
#3,600 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

add details doc_gap reference
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Product: Tarantool
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/other/
SME: @ Totktonada @ igormunkin

Add info about:

  • package.config
  • package.loadlib
  • package.preload
  • package.searchpath
  • package.seeall
  • package.loaders
  • package.search

https://github.com/tarantool/tarantool/blob/master/src/lua/loaders.lua

Details

<…>r

dostring()
Parse and execute an arbitrary
chunk of Lua code

|package.path|
Get file paths used to search
for Lua modules

package.cpath
Ge<…>

https://www.tarantool.io/en/doc/latest/reference/reference_lua/other/

Not all package API is documented. Autocompletion lists the following members:

tarantool> package.
package.config          
package.loaded          
package.loadlib(        
package.preload         
package.searchpath(     
package.seeall(
package.cpath           
package.loaders         
package.path            
package.search(         
package.searchroot(     
package.setsearchroot(

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the root document at reference/reference_lua/other/ and compare its existing package API coverage with the unchecked members listed in the issue. Read src/lua/loaders.lua for the loader-related behavior and use the linked documentation page as the target. Done means the requested package components are documented accurately and the checklist is complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.