FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[Doc] Auto-hide deprecated parameters in Pulsar admin CLI docs · Issue #15771 · apache/pulsar · GitHub

/ pulsar Public

[Doc] Auto-hide deprecated parameters in Pulsar admin CLI docs #15771

Description

What issue do you find in Pulsar docs?

In Pulsar admin CLI docs, some commands have duplicate parameters. For example, processing guarantees have duplicate parameters as shown below:

However, in the code file, we can tell that --processingGuarantees has been deprecated and this information is not demonstrated in docs which may confuse users.

What is your suggestion?

Auto-hide deprecated parameters in Pulsar admin CLI docs by enhancing the auto-generation mechanism.

Do you have any references?

https://pulsar.apache.org/tools/pulsar-admin/2.10.0-SNAPSHOT/#-em-localrun-em-
https://github.com/apache/pulsar/blob/branch-2.10/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java#L279-L280

Would you like to fix this issue?

Ping @urfreespace @tuteng
//cc @Anonymitaet

Note

  • I have researched my question.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    StaledocYour PR contains doc changes, no matter whether the changes are in markdown or code files.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions


      Back | FazBrowse Home | New Git URL