QuantConnect / QuantConnect/Documentation
Improve Importing Data / Streaming / CSV Examples
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 261
- Forks
- 191
- Avg merge
- 16h 28m
- Merged PRs (30d)
- 56
Description
Inline the examples like the other pages so doesn't require linking out.
Show usage of multiple properties.
https://www.quantconnect.com/docs/v2/writing-algorithms/importing-data/streaming-data/custom-securities/csv-format-example
https://www.quantconnect.cloud/backtest/8f24cfcf1e480923d34446501dd37d9f/?theme=chrome
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
Open the importing-data/streaming-data/custom-securities/CSV format example linked in the issue and compare it with the other pages that inline examples. Review the linked backtest to identify multiple properties to demonstrate. Done means the relevant examples are shown inline and cover multiple properties without requiring an external link.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100