updated docs #477
updated docs #477
Conversation
|
My review is in progress 📖 - I will have feedback for you in a few minutes! |
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
There was a problem hiding this comment.
I have reviewed your code and found 2 potential issues. To discuss my individual comments that I have added, tag me in replies using @korbit-ai.
Please react with a 👍 to my comments that you find helpful and a 👎 to those you find unhelpful - this will help me learn and improve as we collaborate.
| html_theme_options = { | ||
| "sidebar_hide_name": True, | ||
| "light_logo": "logo-light-mode.png", | ||
| "dark_logo": "logo-light-mode.png", | ||
| "sidebar_title": "Lumibot", # Custom sidebar title | ||
| 'announcement': """ | ||
| <div class="footer-banner bg-warning text-dark p-3"> | ||
| <h5>Need Extra Help?</h5> | ||
| <p>Visit <a href="https://www.lumiwealth.com/?utm_source=documentation&utm_medium=referral&utm_campaign=lumibot_footer_banner" target="_blank" class="text-dark"><strong>Lumiwealth</strong></a> for courses, community, and profitable pre-made trading bots.</p> | ||
| </div> | ||
| """ | ||
| } |
There was a problem hiding this comment.
I noticed that there are several lines of code that lack inline comments. While the code is relatively straightforward, adding comments would improve the readability and maintainability of the code. Please consider adding comments to explain the purpose and functionality of the code.
| ... # If you want to go live, you must change this | ||
| ... "ENDPOINT": "https://paper-api.alpaca.markets", | ||
| ... # Set this to False to use a live account | ||
| ... "PAPER": True |
There was a problem hiding this comment.
The variable name 'PAPER' in the Alpaca broker configuration is not descriptive enough. Consider renaming it to 'USE_PAPER_ACCOUNT' to make it clear that it is a flag for using a paper trading account. This will improve code readability and maintainability.
No description provided.