Skip to content

Commit

Permalink
docs: minor inline doc fixups (#4281)
Browse files Browse the repository at this point in the history
  • Loading branch information
digikata authored Dec 2, 2024
1 parent 6557978 commit b1b53ce
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ impl SharedConfig {
}
}

/// Corresponds to https://docs.rs/fluvio/latest/fluvio/struct.TopicProducerConfigBuilder.html
/// Corresponds to <https://docs.rs/fluvio/latest/fluvio/struct.TopicProducerConfigBuilder.html>
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct FluvioProducerConfig {
pub batch_size: Vec<u64>,
Expand Down Expand Up @@ -54,7 +54,7 @@ impl Default for FluvioProducerConfig {
}
}

/// Corresponds to https://docs.rs/fluvio/latest/fluvio/consumer/struct.ConsumerConfigBuilder.html
/// Corresponds to <https://docs.rs/fluvio/latest/fluvio/consumer/struct.ConsumerConfigBuilder.html>
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct FluvioConsumerConfig {
pub max_bytes: Vec<u64>,
Expand All @@ -69,7 +69,7 @@ impl Default for FluvioConsumerConfig {
}
}

/// Corresponds to https://docs.rs/fluvio/latest/fluvio/metadata/topic/struct.TopicSpec.html
/// Corresponds to <https://docs.rs/fluvio/latest/fluvio/metadata/topic/struct.TopicSpec.html>
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct FluvioTopicConfig {
pub num_partitions: Vec<u64>,
Expand Down
2 changes: 1 addition & 1 deletion crates/fluvio-test-util/test_meta/environment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ pub struct EnvironmentSetup {
#[arg(long, default_value = "1")]
pub topic: u16,

/// Append random as "-<random>" to topic name (before id, if --num-topics > 1)
/// Append random as "-\<random\>" to topic name (before id, if --num-topics > 1)
#[arg(long)]
pub topic_random: bool,

Expand Down
9 changes: 9 additions & 0 deletions crates/fluvio/src/producer/mod.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
//! The Fluvio Producer module allows applications to send messages to topics in the Fluvio cluster.
//!
//! # Overview
//!
//! This module provides the necessary structures and functions to produce messages to a Fluvio topic.
//! It includes the `TopicProducerPool` struct, which manages the production of messages
//! to specific topics and partitions, respectively.
//!
use std::collections::HashMap;
use std::sync::Arc;

Expand Down Expand Up @@ -47,6 +55,7 @@ pub use self::output::ProduceOutput;
use self::partition_producer::PartitionProducer;
pub use self::record::{FutureRecordMetadata, RecordMetadata};

/// Pool of producers for a given topic. There is a producer per partition
pub type TopicProducerPool = TopicProducer<SpuSocketPool>;

/// Pool of producers for a given topic. There is a producer per partition
Expand Down

0 comments on commit b1b53ce

Please sign in to comment.