Adding comment for snippets - Githubissues

QuantConnect / Documentation

QuantConnect Wiki Style Documentation Behind QuantConnect

https://www.quantconnect.com/docs/v2/

Apache License 2.0

173 stars 139 forks source link

Adding comment for snippets #1829

Closed baobach closed 3 months ago

baobach commented 3 months ago

Description

Adding comments to code blocks.

Motivation and Context

The example code block is missing an explanation of what the code does to avoid confusion.

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)
[x] Non-functional change (xml comments/documentation/etc)

Checklist:

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