Skip to content

Commit

Permalink
[doc] Add faq about how to use code completion in vscode (#6621)
Browse files Browse the repository at this point in the history
Issue: #6404 

### Brief Summary 

This PR doesn't solve the issue in #6404 but it helps a bit for
beginners.

Our type hint isn't perfect yet, but it should at least work for the
python apis. ;) Adding a faq so that users can find them.

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
ailzhang and pre-commit-ci[bot] committed Nov 16, 2022
1 parent a0227ca commit 175b6fb
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/lang/articles/faqs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,17 @@ sidebar_position: 1

# Frequently Asked Questions

## Can I enable auto compeletion for Taichi?

Yes, Taichi's Python user-facing APIs should work natively with any language server for Python.

Take VSCode as an example, you can install `Python` or `Pylance` extensions to get language support like signature help with type information, code completion etc.

If it doesn't work out of box after installing the extension, please make sure the right Python interpreter is selected by:
- invoke command palette (`Shift + Command + P (Mac) / Ctrl + Shift + P (Windows/Linux)`)
- find `Python: Select Interpreter`
- make sure you select the path to the Python interpreter you're using with a `taichi` package installed

### Why does my `pip` complain `package not found` when installing Taichi?

You may have a Python interpreter with an unsupported version. Currently, Taichi only supports Python 3.7/3.8/3.9/3.10 (64-bit) . For more information about installation-specific issues, please check [Installation Troubleshooting](./install.md).
Expand Down

0 comments on commit 175b6fb

Please sign in to comment.