QuantConnect / QuantConnect/Documentation
More Docs Examples with Expected Output
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 261
- Forks
- 191
- Avg merge
- 16h 28m
- Merged PRs (30d)
- 56
Description
Expected Behavior
The pandas documentation provides many examples and the expected output to make understanding their API easier. For example, see the Examples section on https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.merge.html.
Our docs should follow this pattern and provide many examples + expected output, especially in the Research Environment docs.
Actual Behavior
Few examples with expected output
Checklist
- I have completely filled out this template
- I have confirmed that this issue exists on the current
masterbranch - I have confirmed that this is not a duplicate issue by searching issues
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the Research Environment documentation and compare its examples with the pandas DataFrame.merge example linked in the issue. Done means providing many examples with expected output throughout the relevant documentation area.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100