Skip to content

chore: improve code comments clarity #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stringsbuilder wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −6
Open

chore: improve code comments clarity #326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/clob/order_builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,7 @@ impl<K: AuthKind> OrderBuilder<Market, K> {
}
}

/// Removes trailing zeros, truncates to [`USDC_DECIMALS`] decimal places, and quanitizes as an
/// Removes trailing zeros, truncates to [`USDC_DECIMALS`] decimal places, and quantizes as an
/// integer.
fn to_fixed_u128(d: Decimal) -> u128 {
d.normalize()
Expand Down
10 changes: 5 additions & 5 deletions src/clob/ws/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ impl<S: State> Client<S> {

/// Subscribes to real-time tick size change events for specified assets.
///
/// Returns a stream of tick size change when the backend adjusts the minimum
/// Returns a stream of tick size changes when the backend adjusts the minimum
/// price increment for an asset.
///
/// # Arguments
Expand Down Expand Up @@ -390,7 +390,7 @@ impl<S: State> Client<S> {

/// Unsubscribe from orderbook updates for specific assets.
///
/// This decrements the reference count for each asset. The server unsubscribe
/// This decrements the reference count for each asset. The server unsubscribe request
/// is only sent when no other subscriptions are using those assets.
pub fn unsubscribe_orderbook(&self, asset_ids: &[U256]) -> Result<()> {
self.inner
Expand All @@ -401,23 +401,23 @@ impl<S: State> Client<S> {

/// Unsubscribe from price changes for specific assets.
///
/// This decrements the reference count for each asset. The server unsubscribe
/// This decrements the reference count for each asset. The server unsubscribe request
/// is only sent when no other subscriptions are using those assets.
pub fn unsubscribe_prices(&self, asset_ids: &[U256]) -> Result<()> {
self.unsubscribe_orderbook(asset_ids)
}

/// Unsubscribe from tick size change updates for specific assets.
///
/// This decrements the reference count for each asset. The server unsubscribe
/// This decrements the reference count for each asset. The server unsubscribe request
/// is only sent when no other subscriptions are using those assets.
pub fn unsubscribe_tick_size_change(&self, asset_ids: &[U256]) -> Result<()> {
self.unsubscribe_orderbook(asset_ids)
}

/// Unsubscribe from midpoint updates for specific assets.
///
/// This decrements the reference count for each asset. The server unsubscribe
/// This decrements the reference count for each asset. The server unsubscribe request
/// is only sent when no other subscriptions are using those assets.
pub fn unsubscribe_midpoints(&self, asset_ids: &[U256]) -> Result<()> {
self.unsubscribe_orderbook(asset_ids)
Expand Down
Loading