Skip to content

Commit 5d73463

Browse files
committed
squash! Update FAQ to better explain running FD outside of project env
The investigations in issue #460 reveal that for now we are likely less backwards-compatible than we'd like to be. Until that situation is improved, let's tell users to open an issue if they encounter problems. This should help us gauge how to prioritize this.
1 parent 850399c commit 5d73463

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -619,8 +619,8 @@ identical to the package name that you depend on.
619619

620620
### My project is using Python version before v3.8, can I still use FawltyDeps?
621621

622-
Yes! Even though FawltyDeps itself runs on Python >=v3.8, we support analyzing
623-
projects that run on any version of Python 3.
622+
Yes! Even though FawltyDeps itself runs on Python >=v3.8, we try to support
623+
analyzing projects that run on any version of Python 3.
624624

625625
As explained in the previous two questions, FawltyDeps itself does not need to
626626
run inside the same Python environment as you project and its dependencies.
@@ -633,6 +633,15 @@ from inside your project directory. If there is an embedded Python environment
633633
your project dependencies installed within. Or you can always used `--pyenv` to
634634
point FawltyDeps to where your dependencies are installed.
635635

636+
Currently the lowest Python version that your project can use (and still be
637+
analyzed by FawltyDeps) is determined by our use of the
638+
[`ast` module](https://docs.python.org/3/library/ast.html#module-ast) in the
639+
Python standard library: As long as your project's Python syntax is compatible
640+
with the Python version that FawltyDeps runs on, you should be fine. If you run
641+
into problems with older Python syntax (e.g. using `async` or `await` as
642+
variable names), please open an issue, and we'll look into extending our support
643+
further.
644+
636645
### Why does FawltyDeps fail to match `sklearn` with `scikit-learn`?
637646

638647
There are cases, where FawltyDeps may not match imports and obviously related

0 commit comments

Comments
 (0)