Skip to content
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.

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

Docs improvements #610

Merged
merged 2 commits into from
Dec 8, 2024
Merged

Docs improvements #610

merged 2 commits into from
Dec 8, 2024

Conversation

mtvch
Copy link
Contributor

@mtvch mtvch commented Nov 24, 2024

Hi!
I have been reading the sources recently and found a few typos along with a link to a wrong place in brod_group_subscriber_v2.

@@ -159,7 +159,7 @@
%% brod_group_coordinator:start_link/6} Optional</li>
%%
%% <li>`consumer_config': For partition consumer,
%% {@link brod_topic_subscriber:start_link/6}. Optional
%% {@link brod_consumer:start_link/5}. Optional
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it should be brod_topic_subscriber:start_link/7 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sure that consumer_config option accepts config that is passed to brod_consumer:start_link/5, but here in brod_group_consumer_v2 a link leads to brod_topic_subscriber where other irrelevant options are described.

Please, compare brod_consumer config:
https://hexdocs.pm/brod/brod_consumer.html#start_link/5
WIth brod_topic_subscriber config:
https://hexdocs.pm/brod/brod_topic_subscriber.html#start_link/1

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

consumer_group is used here:

start_worker(Client, Topic, MessageType, Partition, ConsumerConfig,
StartOptions) ->
{ok, Pid} = brod_topic_subscriber:start_link( Client
, Topic
, [Partition]
, ConsumerConfig
, MessageType
, brod_group_subscriber_worker
, StartOptions
),
{ok, Pid}.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What I am trying to say is that the link in the description of consumer_config option does not lead to a description of said options, which confused me a bit.

consumer_config options are eventually passed to brod_consumer:start_link/5 and I believe there should be a link to this function, because they are described in it's documentation.

But currently there is a link to brod_topic_subscriber:start_link/1 where docs describe only config of brod_topic_subscriber. consumer_config is one of the options in brod_topic_subscriber's config, but even there a link leads to brod_topic_subscriber itself. I'm going to fix this too in this PR.

In addition, in other places like in brod_group_subscriber description of ConsumerConfig option has a link to brod_consumer docs as I'm suggesting.

@zmstone zmstone merged commit f3deba6 into kafka4beam:master Dec 8, 2024
14 checks passed
@zmstone
Copy link
Contributor

zmstone commented Dec 8, 2024

thank you for the PR @mtvch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants