Skip to content

Commit

Permalink
Remove returns from comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Thoralf-M committed Jan 9, 2024
1 parent 0b84e5f commit 14a724b
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { EpochIndex } from '../../block/slot';
import { u64 } from '../../utils';

/**
* Returns the mana rewards of an account or delegation output.
* The mana rewards of an account or delegation output.
*/
export class ManaRewardsResponse {
/**
Expand Down
4 changes: 2 additions & 2 deletions bindings/nodejs/lib/types/models/api/utxo-changes-response.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Output, OutputDiscriminator } from '../../block/output';
import { Type } from 'class-transformer';

/**
* Returns all UTXO changes that happened at a specific slot.
* All UTXO changes that happened at a specific slot.
*/
export class UtxoChangesResponse {
/**
Expand Down Expand Up @@ -42,7 +42,7 @@ export class OutputWithId {
}

/**
* Returns all full UTXO changes that happened at a specific slot.
* All full UTXO changes that happened at a specific slot.
*/
export class UtxoChangesFullResponse {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export interface ValidatorResponse {
*/
export interface ValidatorsResponse {
/**
* ist of registered validators ready for the next epoch.
* List of registered validators ready for the next epoch.
*/
validators: ValidatorResponse[];
/**
Expand Down
18 changes: 9 additions & 9 deletions sdk/src/types/api/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ use crate::{
};

/// Response of GET /api/core/v3/info.
/// Returns general information about the node.
/// General information about the node.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct InfoResponse {
Expand Down Expand Up @@ -216,7 +216,7 @@ pub struct ValidatorsResponse {
}

/// Response of GET /api/core/v3/rewards/{outputId}.
/// Returns the mana rewards of an account or delegation output.
/// The mana rewards of an account or delegation output.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ManaRewardsResponse {
Expand Down Expand Up @@ -254,7 +254,7 @@ pub struct CommitteeResponse {
pub epoch: EpochIndex,
}

/// Returns information of a committee member.
/// Information of a committee member.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CommitteeMember {
Expand Down Expand Up @@ -413,7 +413,7 @@ pub struct TransactionMetadataResponse {
}

/// Response of GET /api/core/v3/blocks/{blockId}/metadata.
/// Returns the metadata of a block.
/// The metadata of a block.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BlockMetadataResponse {
Expand All @@ -426,15 +426,15 @@ pub struct BlockMetadataResponse {
}

/// Response of GET /api/core/v3/blocks/{blockId}/full.
/// Returns a block and its metadata.
/// A block and its metadata.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct BlockWithMetadataResponse {
pub block: BlockDto,
pub metadata: BlockMetadataResponse,
}

/// Response of GET /api/core/v3/outputs/{output_id}.
/// Returns an output and its metadata.
/// An output and its metadata.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct OutputWithMetadataResponse {
Expand All @@ -458,7 +458,7 @@ impl From<OutputWithMetadata> for OutputWithMetadataResponse {
}

/// Response of GET /api/routes.
/// Returns the available API route groups of the node.
/// The available API route groups of the node.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RoutesResponse {
Expand All @@ -468,7 +468,7 @@ pub struct RoutesResponse {
/// Response of
/// - GET /api/core/v3/commitments/{commitmentId}/utxo-changes
/// - GET /api/core/v3/commitments/by-slot/{slot}/utxo-changes
/// Returns all UTXO changes that happened at a specific slot.
/// All UTXO changes that happened at a specific slot.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UtxoChangesResponse {
Expand All @@ -480,7 +480,7 @@ pub struct UtxoChangesResponse {
/// Response of
/// - GET /api/core/v3/commitments/{commitmentId}/utxo-changes/full
/// - GET /api/core/v3/commitments/by-slot/{slot}/utxo-changes/full
/// Returns all full UTXO changes that happened at a specific slot.
/// All full UTXO changes that happened at a specific slot.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UtxoChangesFullResponse {
Expand Down

0 comments on commit 14a724b

Please sign in to comment.