QuantConnect / QuantConnect/Lean
Order response error messages don't have a link to the documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- C#
- Stars
- 21.7k
- Forks
- 5.3k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 34
Description
Expected Behavior
When we get an OrderResponseErrorCode in an algorithm, the message provides a link to the documentation that elaborates on the error.
Actual Behavior
There aren't currently links to the documentation.
Potential Solution
Add links to the documentation.
Reproducing the Problem
N/A
System Information
N/A
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
- I have provided detailed steps to reproduce the issue
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the OrderResponseErrorCode definitions and the code that constructs their error messages. Add links to the relevant documentation for each message, then verify that OrderResponseErrorCode errors expose those links as expected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100