SMAT-Lab / Scalpel

Scalpel: The Python Static Analysis Framework
Apache License 2.0
286 stars 43 forks source link

Documentation issue #34

Closed khatchad closed 2 years ago

khatchad commented 2 years ago

In https://github.com/SMAT-Lab/Scalpel/wiki/Type-Inference#user-content-how-to-use-type-inference:

The first parameter of TypeInference is the desired name for the inference analyzer, and the second one is the path to a python file or the root folder of a python package.

which is referring to:

inferer = TypeInference(name='type_infer_example.py', entry_point='type_infer_example.py')

Isn't the first parameter the path to a Python file or the root folder of a python package and the second parameter an "entry point?" Are there multiple inference analyzers?

Jarvx commented 2 years ago

Hi, the first parameter is just the name for this inference. The second one can be either a source file path or a folder path (should not end with '/')

We will clarify this in our documentation. Thanks for the question.

khatchad commented 2 years ago

Thank you for the clarification.