From d792c8a6f15750b9d4a14ea3a0d5cdb218343504 Mon Sep 17 00:00:00 2001 From: taozhiwang Date: Sat, 22 Jun 2024 14:49:57 -0400 Subject: [PATCH 1/2] add a note for code standard --- docs/developer/code_standard_and_dev_guide.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/developer/code_standard_and_dev_guide.rst b/docs/developer/code_standard_and_dev_guide.rst index 87f193b8e5..454aa011c8 100644 --- a/docs/developer/code_standard_and_dev_guide.rst +++ b/docs/developer/code_standard_and_dev_guide.rst @@ -61,3 +61,9 @@ The `[dev]` option will help you to install some related packages when developin .. code-block:: bash pip install -e .[dev] + +If you use zsh instead of bash, remember to use the following command. + +.. code-block:: bash + + pip install -e ".[dev]" \ No newline at end of file From 7a7e2d7c0cd079b3b0409a62b1f060778bfa9be0 Mon Sep 17 00:00:00 2001 From: taozhiwang Date: Sun, 23 Jun 2024 12:06:33 -0400 Subject: [PATCH 2/2] handle both cases --- docs/developer/code_standard_and_dev_guide.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/developer/code_standard_and_dev_guide.rst b/docs/developer/code_standard_and_dev_guide.rst index 454aa011c8..26aeb4f0aa 100644 --- a/docs/developer/code_standard_and_dev_guide.rst +++ b/docs/developer/code_standard_and_dev_guide.rst @@ -58,12 +58,6 @@ Development Guidance As a developer, you often want make changes to `Qlib` and hope it would reflect directly in your environment without reinstalling it. You can install `Qlib` in editable mode with following command. The `[dev]` option will help you to install some related packages when developing `Qlib` (e.g. pytest, sphinx) -.. code-block:: bash - - pip install -e .[dev] - -If you use zsh instead of bash, remember to use the following command. - .. code-block:: bash pip install -e ".[dev]" \ No newline at end of file