searchindex.js

Search.setIndex({"docnames": ["changelog", "contribution-guide", "index", "reference/index", "releases", "usage/index", "usage/placeholder"], "filenames": ["changelog.rst", "contribution-guide.rst", "index.rst", "reference/index.rst", "releases.rst", "usage/index.rst", "usage/placeholder.rst"], "titles": ["Changelog", "Contribution guide", "Type Lens", "API Reference", "Type Lens Releases", "Usage", "Placeholder"], "terms": {"all": [0, 1, 4], "commit": [0, 1], "thi": [0, 1, 2, 4], "project": 0, "file": [0, 1], "see": [0, 2], "0e209b": 0, "567f49a": 0, "diff": 0, "0": [0, 4], "6405898": 0, "add": 0, "parameterview": 0, "pkg": 0, "n": 0, "peter": 0, "schutt": 0, "3d80638": 0, "move": 0, "litestar": [0, 4], "jacob": 0, "coffe": 0, "bea1211": 0, "discord": 0, "link": 0, "55ef5f6": 0, "page": 0, "14b0898": 0, "updat": [0, 6], "filler": 0, "content": 0, "version": [0, 1], "105043a": 0, "better": 0, "empti": 0, "type": [0, 1], "2076afe": 0, "us": [0, 1, 2, 3, 4, 5], "plain": 0, "old": 0, "python": 0, "class": [0, 3], "0da8b24": 0, "appli": [0, 1, 4], "pre": [0, 1, 2], "len": [0, 1], "instal": 1, "pizza": 1, "deliveri": 1, "man": 1, "pdm": 1, "g": 1, "virtual": 1, "depend": 1, "If": 1, "you": [1, 6], "re": 1, "work": [1, 4, 6], "need": 1, "build": 1, "extra": 1, "hook": 1, "fork": 1, "repositori": 1, "clone": 1, "your": 1, "git": 1, "make": [1, 4], "chang": [1, 2, 4], "option": 1, "linter": 1, "formatt": 1, "step": 1, "i": [1, 2, 3, 4, 5], "execut": 1, "automat": [1, 3], "befor": [1, 4], "mai": [1, 4], "want": 1, "manual": 1, "order": 1, "fix": 1, "push": 1, "open": 1, "pull": 1, "request": 1, "give": 1, "descript": 1, "titl": 1, "indic": 1, "what": [1, 3, 5], "ha": 1, "correspond": 1, "issu": 1, "number": 1, "should": [1, 4], "includ": [1, 3], "well": 1, "For": [1, 4], "exampl": [1, 4], "bug": 1, "increas": 1, "stack": 1, "size": 1, "imposs": 1, "find": [1, 3], "needl": 1, "100": 1, "could": 1, "easier": 1, "fire": 1, "haystack": 1, "follow": [1, 4], "convent": 1, "format": 1, "fulli": 1, "enforc": 1, "via": 1, "mypi": 1, "pytest": 1, "properli": 1, "black": 1, "ruff": 1, "section": [1, 3], "The": [1, 2, 3, 4, 5], "locat": 1, "directori": 1, "rest": 1, "sphinx": 1, "unfamiliar": 1, "ani": [1, 4], "those": 1, "restructuredtext": 1, "primer": 1, "quickstart": 1, "ar": [1, 3, 4, 5], "recommend": [1, 2], "read": 1, "To": 1, "first": 1, "requir": 1, "Then": 1, "can": [1, 4], "serv": 1, "them": [1, 5], "increment": 1, "pyproject": 1, "toml": 1, "semant": [1, 4], "pep": 1, "440": 1, "draft": 1, "github": 1, "vmajor": 1, "minor": [1, 4], "patch": [1, 4], "e": 1, "v1": 1, "2": [1, 4], "3": [1, 4], "both": 1, "tag": 1, "fill": 1, "gener": [1, 3], "note": [1, 2], "function": [1, 4], "get": 1, "main": [1, 4], "publish": 1, "go": [1, 4], "action": 1, "approv": 1, "check": [1, 6], "successfulli": 1, "releas": 2, "alpha": [2, 4], "stage": 2, "pleas": [2, 6], "current": [2, 4], "develop": [2, 4], "mean": 2, "librari": [2, 4, 5], "still": 2, "under": 2, "activ": [2, 4], "its": 2, "api": 2, "subject": 2, "we": [2, 4], "encourag": 2, "experi": 2, "provid": [2, 5], "feedback": 2, "against": 2, "product": 2, "environ": 2, "until": [2, 4], "stabl": [2, 4], "avail": [2, 5], "more": [2, 4], "inform": 2, "stabil": 2, "polici": 2, "cool": 2, "built": 2, "do": 2, "stuff": 2, "from": [3, 4], "docstr": 3, "code": 3, "out": [3, 4], "method": 3, "attribut": 3, "given": 3, "divid": 3, "sever": [3, 4], "each": [3, 4], "which": 3, "list": 3, "below": 3, "privat": 3, "standard": 4, "major": 4, "schema": 4, "backward": 4, "incompat": 4, "have": 4, "been": 4, "made": 4, "wa": 4, "ad": 4, "compat": 4, "manner": 4, "bugfix": 4, "were": 4, "new": 4, "beta": 4, "candid": 4, "rc": 4, "release_typ": 4, "0alpha1": 4, "0beta1": 4, "0rc1": 4, "earli": 4, "preview": 4, "featur": [4, 5], "complet": 4, "break": 4, "occur": 4, "expect": 4, "freez": 4, "onli": 4, "final": 4, "suitabl": 4, "test": 4, "migrat": 4, "upcom": 4, "design": 4, "life": 4, "seri": 4, "These": 4, "receiv": 4, "guarante": 4, "period": 4, "time": 4, "defin": 4, "when": 4, "remov": 4, "warn": 4, "continu": 4, "next": 4, "1": 4, "throughout": 4, "x": 4, "At": 4, "organ": 4, "previou": 4, "other": 4, "special": 4, "case": 4, "drop": 4, "select": 4, "backport": 4, "older": 4, "base": 4, "feasibl": 4, "cycl": 4, "consist": 4, "few": 4, "phase": 4, "plan": 4, "roadmap": 4, "spec": 4, "begin": 4, "implement": 4, "end": [4, 5], "an": [4, 5], "branch": 4, "A": 4, "b": 4, "progress": [4, 6], "becom": 4, "avoid": 4, "regress": 4, "document": 5, "user": 5, "It": 5, "high": 5, "level": 5, "overview": 5, "how": 5, "placehold": 5, "ve": 6, "stumbl": 6, "upon": 6, "beauti": 6, "excus": 6, "our": 6, "unfinish": 6, "back": 6, "soon": 6}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"changelog": 0, "releas": [0, 1, 4], "v0": 0, "1": 0, "0a1": 0, "2024": 0, "04": 0, "26": 0, "bug": 0, "fix": 0, "document": [0, 1], "refactor": 0, "ci": 0, "contribut": 1, "guid": 1, "set": 1, "up": 1, "environ": 1, "code": 1, "workflow": 1, "guidelin": 1, "write": 1, "run": 1, "test": 1, "todo": [1, 6], "project": 1, "doc": 1, "local": 1, "creat": 1, "new": 1, "type": [2, 4], "len": [2, 4], "introduct": 2, "purpos": 2, "api": 3, "refer": 3, "avail": 3, "version": 4, "number": 4, "pre": 4, "long": 4, "term": 4, "support": 4, "lt": 4, "deprec": 4, "polici": 4, "process": 4, "usag": 5, "placehold": 6}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 58}, "alltitles": {"API Reference": [[3, "api-reference"]], "Available API References": [[3, "available-api-references"]], "Changelog": [[0, "changelog"]], "Release [v0.1.0a1] - 2024-04-26": [[0, "id1"]], "Bug Fixes": [[0, "bug-fixes"]], "Documentation": [[0, "documentation"]], "Refactor": [[0, "refactor"]], "Ci": [[0, "ci"]], "Type Lens": [[2, "type-lens"]], "Introduction": [[2, "introduction"]], "Purpose": [[2, "purpose"]], "Contribution guide": [[1, "contribution-guide"]], "Setting up the environment": [[1, "setting-up-the-environment"]], "Code contributions": [[1, "code-contributions"]], "Workflow": [[1, "workflow"]], "Guidelines for writing code": [[1, "guidelines-for-writing-code"]], "Writing and running tests": [[1, "writing-and-running-tests"]], "Todo": [[1, "id1"], [6, "id1"]], "Project documentation": [[1, "project-documentation"]], "Running the docs locally": [[1, "running-the-docs-locally"]], "Creating a new release": [[1, "creating-a-new-release"]], "Placeholder": [[6, "placeholder"]], "Usage": [[5, "usage"]], "Type Lens Releases": [[4, "type-lens-releases"]], "Version Numbering": [[4, "version-numbering"]], "Pre-release Versions": [[4, "pre-release-versions"]], "Long-term Support Releases (LTS)": [[4, "long-term-support-releases-lts"]], "Deprecation Policy": [[4, "deprecation-policy"]], "Supported Versions": [[4, "id1"]], "Release Process": [[4, "release-process"]]}, "indexentries": {}})