Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct errors and typos in doc strings #1338

Merged
merged 6 commits into from
Nov 7, 2022

Conversation

qianyun210603
Copy link
Contributor

Description

Fix some types and missing's in doc strings.

Motivation and Context

make the doc strings better

How Has This Been Tested?

  • Pass the test by running: pytest qlib/tests/test_all_pipeline.py under upper directory of qlib.
  • If you are adding a new feature, test on your own test scripts.

Screenshots of Test Results (if appropriate):

  1. Pipeline test:
  2. Your own tests:

Types of changes

  • Fix bugs
  • Add new feature
  • Update documentation

@@ -244,7 +244,7 @@ def backtest(
benchmark: str
the benchmark for reporting.
account : Union[float, int, Position]
information for describing how to creating the account
information for describing how to creat the account
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

create

qlib/backtest/__init__.py Outdated Show resolved Hide resolved
examples/run_all_model.py Outdated Show resolved Hide resolved
examples/run_all_model.py Outdated Show resolved Hide resolved
@you-n-g you-n-g merged commit 94e420f into microsoft:main Nov 7, 2022
@you-n-g
Copy link
Collaborator

you-n-g commented Nov 7, 2022

It looks great!
Thanks.
Welcome to become one of Qlib's contributors.

@you-n-g you-n-g added the documentation Improvements or additions to documentation label Dec 9, 2022
qianyun210603 added a commit to qianyun210603/qlib that referenced this pull request Mar 23, 2023
* add missing parameters to doc string in order_generate

* fix some typos in doc strings

* reformat base on code style standard

* Update qlib/backtest/__init__.py

* Update examples/run_all_model.py

* Update examples/run_all_model.py

Co-authored-by: you-n-g <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants