-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Open
Labels
documentationgood first issueIf you're looking to get started as a LEAN contributor, check out these starter issues!If you're looking to get started as a LEAN contributor, check out these starter issues!
Description
Expected Behavior
All code references in XML documentation comments (in classes, methods, properties, etc.) must use the proper tags:
seetag with acrefattribute to reference methods, properties, fields or other classes.- The references should not have namespaces in them and should rely on
usingstatements instead, at least on most cases where possible.
- The references should not have namespaces in them and should rely on
paramreftag to reference parameters of the method.
This will allow the Python stubs to properly map these references to their correct snake-case version. See QuantConnect/quantconnect-stubs-generator#89
This file contains all classes, methods, properties, etc. that potentially need to be adjusted to use the proper XML tags to reference code. This branch can be used to re-generate the file, just run the stubs generator and find the file in bin/Debug/net9.0/summaries.txt
Actual Behavior
A lot of summaries and XML comments in general contain classes/methods/properties names without using the propert XML tags to reference them.
Potential Solution
Use XML tags to reference code where needed
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
Metadata
Metadata
Assignees
Labels
documentationgood first issueIf you're looking to get started as a LEAN contributor, check out these starter issues!If you're looking to get started as a LEAN contributor, check out these starter issues!