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

Improve the style of documentation #1132

Merged
merged 2 commits into from
Jul 7, 2022
Merged

Conversation

bingyao
Copy link
Contributor

@bingyao bingyao commented Jun 15, 2022

Description

This commit improves the documentation (rst files) only in the
following three ways:

  • Aligned section headers with their underline/overline punctuation characters

  • Deleted all trailling whitespaces in rst files

  • Deleted a few trailling newlines at the end of the rst files

Motivation and Context

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

This commit improves the documentation (rst files) only in the
following three ways:

* Aligned section headers with their underline/overline punctuation characters

* Deleted all trailling whitespaces in rst files

* Deleted a few trailling newlines at the end of the rst files
@you-n-g
Copy link
Collaborator

you-n-g commented Jun 28, 2022

Please merge the main branch to run the new version of CI. Thanks

@you-n-g you-n-g merged commit 1dededa into microsoft:main Jul 7, 2022
@you-n-g
Copy link
Collaborator

you-n-g commented Jul 7, 2022

It looks great!
Thanks!

@you-n-g you-n-g added the documentation Improvements or additions to documentation label Dec 9, 2022
qianyun210603 pushed a commit to qianyun210603/qlib that referenced this pull request Mar 23, 2023
This commit improves the documentation (rst files) only in the
following three ways:

* Aligned section headers with their underline/overline punctuation characters

* Deleted all trailling whitespaces in rst files

* Deleted a few trailling newlines at the end of the rst files

Co-authored-by: Bingyao Liu <Bingyao.Liu@sofund.com>
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