-
Notifications
You must be signed in to change notification settings - Fork 74
Add comprehensive documentation for supported assets and timeframes #39
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
Conversation
|
@theshadow76 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: theshadow76 <59869868+theshadow76@users.noreply.github.com>
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds a comprehensive documentation page listing all 121 supported trading assets and 14 timeframes available in the PocketOption API. The documentation is well-organized into categories (Major Forex, OTC Forex, Commodities, Cryptocurrencies, Stock Indices, and US Stocks) and provides practical code examples for using these assets. The page integrates seamlessly with the existing documentation by adding navigation links across all HTML files and following the established purple-themed design.
Key Changes:
- Created new
assets-timeframes.htmlwith detailed asset listings and timeframe reference - Added navigation link to "Assets & Timeframes" in all existing documentation pages
- Included practical usage examples demonstrating how to use asset symbols with the API
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/assets-timeframes.html | New comprehensive documentation page with all supported assets, timeframes, usage examples, and styling |
| docs/index.html | Added navigation link to new assets-timeframes page |
| docs/quickstart.html | Added navigation link to new assets-timeframes page |
| docs/api.html | Added navigation link to new assets-timeframes page |
| docs/examples.html | Added navigation link to new assets-timeframes page |
| docs/faq.html | Added navigation link to new assets-timeframes page |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <a href="quickstart.html">Quickstart</a> | ||
| <a href="api.html">API Reference</a> | ||
| <a href="examples.html">Examples</a> | ||
| <a href="assets-timeframes.html" class="active">Assets & Timeframes</a> |
Copilot
AI
Nov 29, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "active" class is applied to the current navigation link but there is no corresponding CSS style defined in style.css. This class has no visual effect. Either add a CSS rule for .active class in style.css (e.g., to highlight the current page in navigation) or remove the class attribute if not needed.
|
|
||
| # Getting data for different asset types | ||
| forex_candles = await client.get_candles("GBPUSD_otc", TimeFrame.H1, 24) | ||
| crypto_candles = await client.get_candles("ETHUSD", TimeFrame.M15, 96) |
Copilot
AI
Nov 29, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The code example uses "ETHUSD" but earlier in line 355 uses "GBPUSD_otc". For consistency with the practical examples showing different asset types, consider using "BTCUSD" (as used in line 352) or another crypto asset that's distinct from the one in line 352 to demonstrate variety. However, ETHUSD is valid and this is only a minor consistency suggestion.
| crypto_candles = await client.get_candles("ETHUSD", TimeFrame.M15, 96) | |
| crypto_candles = await client.get_candles("LTCUSD", TimeFrame.M15, 96) |
| <div class="asset-item">Facebook_OTC <em>(Facebook Alternative)</em></div> | ||
| <div class="asset-item">Tesla_otc <em>(Tesla Alternative)</em></div> | ||
| <div class="asset-item">Boeing_OTC <em>(Boeing Alternative)</em></div> |
Copilot
AI
Nov 29, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent capitalization in OTC suffix: "Facebook_OTC" and "Boeing_OTC" use uppercase "OTC" while "Tesla_otc" uses lowercase "otc". According to the source code constants.py, the correct symbols are "Facebook_OTC" (line 135), "Tesla_otc" (line 136), and "Boeing_OTC" (line 137). The documentation correctly reflects the source code, but this inconsistency in the actual asset naming could confuse users. Consider adding a note in the "Important Notes" section about exact case sensitivity for these specific alternative format symbols.
| .asset-grid { | ||
| display: grid; | ||
| grid-template-columns: repeat(auto-fit, minmax(200px, 1fr)); |
Copilot
AI
Nov 29, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The grid layout uses minmax(200px, 1fr) which may cause horizontal scrolling on very small mobile screens (< 200px wide). Consider using a smaller minimum width (e.g., 150px or 180px) or adding a media query to adjust the grid for very small screens to improve mobile accessibility.
This PR adds comprehensive documentation for all supported assets and timeframes in the PocketOption API, addressing the community request for clarity on what trading instruments are available.
What's Added
New Documentation Page
/docs/assets-timeframes.htmlwith complete listings of all supported trading instrumentsComprehensive Asset Coverage (121 total assets)
Complete Timeframe Documentation (14 timeframes)
TimeFrameenum values and raw seconds providedEnhanced User Experience
Code Examples
The documentation includes practical examples showing how to use the asset symbols:
This documentation eliminates confusion about which assets are supported and provides developers with the exact symbols needed for API calls.
Fixes #38.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.