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.

Sign up for GitHub

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

Jump to bottom

Add missing description for cli commands #1290

Closed
wants to merge 2 commits into from
Closed

Add missing description for cli commands #1290

wants to merge 2 commits into from

Conversation

LouisSzeto
Copy link
Collaborator

@LouisSzeto LouisSzeto commented May 8, 2023 •
edited
Loading

Description

Add missing description for cli commands in Lean CLI -> API Reference

Related Issue

closes #1247

Motivation and Context

missing info

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which improves implementation)
  • New feature (non-breaking change which adds functionality)
  • Non-functional change (xml comments/documentation/etc)

Checklist:

  • My code follows the code style of this project.
  • I have read the CONTRIBUTING document.
  • My branch follows the naming convention bug-<issue#>-<description> or feature-<issue#>-<description>

DerekMelchin
DerekMelchin reviewed May 8, 2023
View reviewed changes
Copy link
Collaborator

@DerekMelchin DerekMelchin left a comment

Choose a reason for hiding this comment

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

These descriptions are essentially the same content as the Introduction on each page. Perhaps the content should be unique.

@DerekMelchin
Copy link
Collaborator

Please review the other descriptions in the LEAN CLI docs for guidance on the content style.
For example, https://www.quantconnect.com/docs/v2/lean-cli/api-reference/lean-backtest#02-Description

@LouisSzeto LouisSzeto closed this May 10, 2023
@LouisSzeto LouisSzeto reopened this May 10, 2023
@AlexCatarino AlexCatarino force-pushed the master branch 2 times, most recently from e71e324 to ca0eea4 Compare July 18, 2023 22:09
@AlexCatarino AlexCatarino force-pushed the master branch 5 times, most recently from 8fa2978 to c1576a1 Compare August 3, 2023 20:15
@DerekMelchin DerekMelchin deleted the bug-1247-missing-cli-description branch September 8, 2023 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DerekMelchin DerekMelchin DerekMelchin left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing Descriptions in CLI API Reference
3 participants
@LouisSzeto @DerekMelchin @AlexCatarino