mirror of
https://github.com/microsoft/qlib.git
synced 2026-06-06 05:51:17 +08:00
17d472cf01
* Update code_standard.rst * Update docs/developer/code_standard.rst Co-authored-by: you-n-g <you-n-g@users.noreply.github.com> Co-authored-by: you-n-g <you-n-g@users.noreply.github.com>
23 lines
784 B
ReStructuredText
23 lines
784 B
ReStructuredText
.. _code_standard:
|
|
|
|
=================================
|
|
Code Standard
|
|
=================================
|
|
|
|
Docstring
|
|
=================================
|
|
Please use the `Numpydoc Style <https://stackoverflow.com/a/24385103>`_.
|
|
|
|
Continuous Integration
|
|
=================================
|
|
Continuous Integration (CI) tools help you stick to the quality standards by running tests every time you push a new commit and reporting the results to a pull request.
|
|
|
|
When you submit a PR request, you can check whether your code passes the CI tests in the "check" section at the bottom of the web page.
|
|
|
|
A common error is the mixed use of space and tab. You can fix the bug by inputing the following code in the command line.
|
|
|
|
.. code-block:: python
|
|
|
|
pip install black
|
|
python -m black . -l 120
|