QuantConnect / Documentation

QuantConnect Wiki Style Documentation Behind QuantConnect
https://www.quantconnect.com/docs/v2/
Apache License 2.0
173 stars 139 forks source link

Update Margin Calls 06 Model Structure.html #1799

Closed kevinwheeler closed 3 months ago

kevinwheeler commented 5 months ago

Small terminology correction

Description

Related Issue

Motivation and Context

Types of changes

Checklist:

kevinwheeler commented 3 months ago

Hi @AlexCatarino , Thank you for the reply. I don't understand. The current text reads:

"The GetMarginCallOrders method scans the portfolio and the updated data for a potential margin call situation that may get the holdings below zero. The method must return a list of objects that represent the margin call orders. To issue a margin call warning during this method, set the argument of the method to true.

You said "When we get below maintenance margin but not below zero yet, we create the orders"

Shouldn't "zero" be replaced with "maintenance margin" in the text above, since we will create the orders when we get below maintenance margin, and not when we get below zero?

2) If I understand you right, you also say that "total portfolio value" would be a better substitute than "equity". I agree.