QuantConnect / QuantConnect/Lean

Organize User Facing Messages

Open
#6,866 0 comments 0 reactions 1 assignee View on GitHub

@jhonabreul is already working on this.

Since Jan 16, 2023.

refactor
Dominant language
C#
Stars
21.7k
Forks
5.3k
Avg merge
2d 22h
Merged PRs (30d)
34

Description

Expected Behavior
  • All user facing messages can be found in a single location (folder). This will allow to easily update, maintain and potentially support multiple languages. Make it easy for the docs team.
Actual Behavior
  • User facing messages are coming from multiple locations around the code base
Potential Solution
  • Create new Messages folder under Common project to hold all user facing messages. Warning and errors for: orders, data, algorithm api, brokerage in lean and other repos, history, etc
  • Mutliple PRs
  • public static partial class Message with readonly messages

Edit after PRs #6915 #6916 #6922
We are separating the work by namepaces and we will use this issue to track it:

  • QuantConnect
    • QuantConnect (QuantConnect .* direct classes)
    • Algorithm
      • Framework
        • Alphas
        • Portfolio
    • Api
    • Benchmarks
    • Brokerages
    • Commands
    • Data
    • Exceptions
    • Indicators
    • Interfaces
    • Notifications
    • Optimizer
    • Orders
      • Orders (Orders .* direct classes)
      • Fees
      • Fills
      • OptionExercise
      • Serialization
      • Slippage
      • TimeInForces
    • Packets
    • Parameters
    • Python
    • Scheduling
    • Securities
      • Securities (Securities.* direct classes)
      • Cfd
      • Crypto
      • CryptoFuture
      • CurrencyConversion
      • Equity
      • Forex
      • Future
      • FutureOption
      • Index
      • IndexOption
      • Interfaces
      • Option
      • Positions
      • Volatility
    • Statistics
    • Storage
    • Util
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 master branch
  • I have confirmed that this is not a duplicate issue by searching issues
  • I have provided detailed steps to reproduce the issue

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.