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.

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

docs: add instruction on how to disable various warnings and annoyanc… #4179

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,27 @@ of the animation inside the editor. The extension can be installed through the
This extension is not officially maintained by the Manim Community.
If you run into issues, please report them to the extension's author.

If you are using an editor such as `Helix <https://github.com/helix-editor/helix>`__ and you rely on language servers, you may get face several annoyances.

The language server will complain about the wildcard import, and every time a variable is referenced from manim you will get a warning such as: Scene may be undefined, or defined from star imports

Additionally, when items from Manim are autocompleted, the language server may automatically import items from Manim even though Manim is imported via a glob import.

To fix the issues above, you will need to configure your language server to disable automatic import on completion. For Helix, this would be for example:

.. code-block:: toml

[language-server]
pyright = { command = "pyright-langserver", args = [
"--stdio",
], config = { "python.analysis.autoImportCompletions" = false } }

To disable the warnings around star imports, modify your :code:`pyproject.toml` file:

.. code-block:: toml

[tool.ruff]
ignore = ["F403", "F405"]

Installation for developers
***************************
Expand Down