nexustrade 3.1.0 → 3.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -438,10 +438,12 @@ export interface DynamicRebalanceAction {
438
438
  */
439
439
  canSell?: Condition | CandidateCondition;
440
440
  /**
441
- * BACKTEST-ONLY. Permits negative rebalance targets (equity short legs).
442
- * The backtest assumes shares were available to short each morning and
443
- * accrues a modeled borrow fee. Live/paper deploy of a short strategy is
444
- * rejected at deploy time (explicit non-parity with backtest).
441
+ * Permits negative rebalance targets (equity short legs, whole shares).
442
+ * Backtests and paper assume shares were available to short each morning
443
+ * and accrue a modeled borrow fee. Live deploy needs a brokerage that can
444
+ * short stock (Alpaca, Tradier, TradeStation, Public; margin account);
445
+ * elsewhere deploy is rejected. For a fixed-size short of one stock use
446
+ * short() / cover() instead.
445
447
  */
446
448
  allowShorts?: boolean;
447
449
  allocationPolicy?: AllocationPolicy;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nexustrade",
3
- "version": "3.1.0",
3
+ "version": "3.1.1",
4
4
  "description": "Typed TypeScript SDK for NexusTrade portfolio authoring, backtesting, and optimization",
5
5
  "license": "MIT",
6
6
  "author": "Starks Technology",