diff --git a/README.md b/README.md index 42c446e69e5..c8950d56cc4 100644 --- a/README.md +++ b/README.md @@ -201,7 +201,7 @@ Also, users can install the latest dev version ``Qlib`` by the source code accor * Clone the repository and install ``Qlib`` as follows. ```bash git clone https://github.com/microsoft/qlib.git && cd qlib - pip install . # `pip install -e .[dev]` is recommended for development. check details in docs/developer/code_standard_and_dev_guide.rst + pip install . # `pip install -e '.[dev]'` is recommended for development. check details in docs/developer/code_standard_and_dev_guide.rst ``` **Tips**: If you fail to install `Qlib` or run the examples in your environment, comparing your steps and the [CI workflow](.github/workflows/test_qlib_from_source.yml) may help you find the problem. diff --git a/docs/developer/code_standard_and_dev_guide.rst b/docs/developer/code_standard_and_dev_guide.rst index 26aeb4f0aac..a63278241d5 100644 --- a/docs/developer/code_standard_and_dev_guide.rst +++ b/docs/developer/code_standard_and_dev_guide.rst @@ -47,7 +47,7 @@ When you submit a PR request, you can check whether your code passes the CI test .. code-block:: bash - pip install -e .[dev] + pip install -e '.[dev]' pre-commit install