Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bryaningl3 committed Aug 8, 2023
1 parent 8888fbf commit 8180846
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 1 deletion.
10 changes: 10 additions & 0 deletions docs/content/release_notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Release Notes

## 6.0.3
**New Features**

* Added the `UnitCode.getMinimumTick` function.
* Added the `UnitCode.getMinimumTickValue` function.

**Other**

* Improved the documentation for the `Profile.tickincrement` property.

## 6.0.2
**Bug Fixes**

Expand Down
2 changes: 1 addition & 1 deletion docs/content/sdk/lib-marketstate.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@

| Name | Type | Description |
| --- | --- | --- |
| tickIncrement | <code>number</code> | <p>The minimum price movement.</p> |
| tickIncrement | <code>number</code> | <p>The minimum price movement, expressed as an integer multiple of the number of the possible divisions within one unit. For example, the number of discrete divisions of a dollar is 100. If the tick increment is ten, that means quotes and trades can occur at $0.10, $0.20, $0.30, etc.</p> |


* * *
Expand Down
33 changes: 33 additions & 0 deletions docs/content/sdk/lib-utilities-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,8 @@
* [.fractionDigitsSpecial](#UnitCodefractionDigitsSpecial) ⇒ <code>Number</code> \| <code>undefined</code>
* [.getFractionFactor([special])](#UnitCodegetFractionFactor) ⇒ <code>Number</code> \| <code>undefined</code>
* [.getFractionDigits([special])](#UnitCodegetFractionDigits) ⇒ <code>Number</code> \| <code>undefined</code>
* [.getMinimumTick(tickIncrement)](#UnitCodegetMinimumTick) ⇒ <code>Number</code>
* [.getMinimumTickValue(tickIncrement, pointValue)](#UnitCodegetMinimumTickValue)
* _static_
* [.parse(code)](#UnitCodeparse)[<code>UnitCode</code>](#UnitCode) \| <code>null</code>
* [.fromBaseCode(code)](#UnitCodefromBaseCode)[<code>UnitCode</code>](#UnitCode) \| <code>null</code>
Expand Down Expand Up @@ -281,6 +283,37 @@
| [special] | <code>Boolean</code> |


* * *

### unitCode.getMinimumTick(tickIncrement) :id=unitcodegetminimumtick
> Determines the minimum price fluctuation. In other words, multiples
> of this value determine the set of valid quote and trade prices
> for an instrument.
**Kind**: instance method of [<code>UnitCode</code>](#UnitCode)
**Returns**: <code>Number</code>
**Access**: public

| Param | Type | Description |
| --- | --- | --- |
| tickIncrement | <code>Number</code> | <p>Taken from a [Profile](/content/sdk/lib-marketstate?id=profile) instance.</p> |


* * *

### unitCode.getMinimumTickValue(tickIncrement, pointValue) :id=unitcodegetminimumtickvalue
> Returns the change in value of a position when the instrument's price moves
> up by the minimum tick.
**Kind**: instance method of [<code>UnitCode</code>](#UnitCode)
**Access**: public

| Param | Type | Description |
| --- | --- | --- |
| tickIncrement | <code>Number</code> | <p>Taken from a [Profile](/content/sdk/lib-marketstate?id=profile) instance.</p> |
| pointValue | <code>Number</code> | <p>Taken from a [Profile](/content/sdk/lib-marketstate?id=profile) instance.</p> |


* * *

### UnitCode.parse(code) :id=unitcodeparse
Expand Down

0 comments on commit 8180846

Please sign in to comment.