You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When we have a method in the docs (ex: History), we show the class that it's a part of (ex: QCAlgorithm.History) in the text when we describe the method.
Actual Behavior
The docs currently only show the member/method name, not the class. It can be confusing for new members who aren't familiar. For instance, if someone was copy-pasting the code snippets from https://www.quantconnect.com/docs/v2/writing-algorithms/historical-data/history-requests into an Alpha model, they wouldn't work because they would need to replace self with algorithm.
Checklist
I have completely filled out this template
I have confirmed that this issue exists on the current master branch
I have confirmed that this is not a duplicate issue by searching issues
The text was updated successfully, but these errors were encountered:
Expected Behavior
History
), we show the class that it's a part of (ex:QCAlgorithm.History
) in the text when we describe the method.Actual Behavior
The docs currently only show the member/method name, not the class. It can be confusing for new members who aren't familiar. For instance, if someone was copy-pasting the code snippets from https://www.quantconnect.com/docs/v2/writing-algorithms/historical-data/history-requests into an Alpha model, they wouldn't work because they would need to replace
self
withalgorithm
.Checklist
master
branchThe text was updated successfully, but these errors were encountered: