Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1 KB

File metadata and controls

24 lines (16 loc) · 1 KB

LanceDB Mintlify Documentation

This is a documentation site for LanceDB.

Languages used

  • Code examples are primarily in three language SDKs: Python, TypeScript and Rust.
  • Best practices for linting, formatting and code complexity for each respective language apply.
  • Write idiomatic code as far as possible

Running Python code

When running Python code, we have to cater to users of both pip and uv.

  • Use 4 spaces to represent a tab (do not use tab characters)
  • Always attempt to first run any Python code via the local virtual environment
    • Look for a local virtual environment (typically in .venv or venv)
    • Activate the environment, so that you can run multiple code exampes in the same environment
  • Avoid using uv run directly, as you have issues running it in your sandbox
  • Only fall back to the system python3 to run code if the above steps don't work

Generate snippets

  • Generate the required code snippets using the provided Makefile: make snippets