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

[fix][doc] Fix wrong description of pulsar.allocator.leak_detection and remove 'Client memory allocator configuration' section from the old version doc #17004

Merged
merged 1 commit into from
Aug 18, 2022

Conversation

RobertIndie
Copy link
Member

@RobertIndie RobertIndie commented Aug 9, 2022

Fixes #16804

Motivation

The property "pulsar.allocator.leak_detection" has wrong description: "Service URL provider for Pulsar service" in https://pulsar.apache.org/docs/client-libraries-java/#client-memory-allocator-configuration.

In addition, this PR also remove 'Client memory allocator configuration' section from the old version doc. This section should only appear after 2.10.0 and seems to be mistakenly added to the old version. See this PR: #12481

Modifications

  • Fix the wrong description.
  • Remove 'Client memory allocator configuration' section from the old version doc.
    Here is the preview:

image

Documentation

Check the box below or label this PR directly.

Need to update docs?

  • doc-required
    (Your PR needs to update docs and you will update later)

  • doc-not-needed
    (Please explain why)

  • doc
    (Your PR contains doc changes)

  • doc-complete
    (Docs have been already added)

@RobertIndie RobertIndie self-assigned this Aug 9, 2022
@RobertIndie RobertIndie added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Aug 9, 2022
@RobertIndie RobertIndie added this to the 2.12.0 milestone Aug 9, 2022
momo-jun added a commit to momo-jun/pulsar that referenced this pull request Aug 9, 2022
… and remove Client memory allocator configuration from the old version doc

Signed-off-by: Zike Yang <zike@apache.org>
@RobertIndie RobertIndie changed the title [fix][doc] Fix wrong description of pulsar.allocator.leak_detection [fix][doc] Fix wrong description of pulsar.allocator.leak_detection and remove 'Client memory allocator configuration' section from the old version doc Aug 9, 2022
Copy link
Contributor

@momo-jun momo-jun left a comment

Choose a reason for hiding this comment

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

LGTM.

@Anonymitaet Anonymitaet merged commit db859bb into apache:master Aug 18, 2022
@momo-jun momo-jun modified the milestones: 2.12.0, 2.11.0 Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Wrong property description
3 participants