Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specify object of members/methods #1517

Open
3 tasks done
DerekMelchin opened this issue Oct 20, 2023 · 0 comments
Open
3 tasks done

Specify object of members/methods #1517

DerekMelchin opened this issue Oct 20, 2023 · 0 comments

Comments

@DerekMelchin
Copy link
Collaborator

Expected Behavior

  • 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant