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

When generate doc, ignore the hidden parameters. by horizonzy · Pull Request #16298 · apache/pulsar · GitHub

/ pulsar Public

When generate doc, ignore the hidden parameters. - #16298

Merged
Anonymitaet merged 3 commits into
apache:masterfrom
horizonzy:fix-doc-gen-problem
Jul 1, 2022
ConversationCommits (3)ChecksFiles changed
Merged

When generate doc, ignore the hidden parameters.#16298
Anonymitaet merged 3 commits into
apache:masterfrom
horizonzy:fix-doc-gen-problem

Conversation

horizonzy commented Jun 30, 2022 •
edited by Anonymitaet
Loading

Copy link
Copy Markdown
Member

Fixes #15771

Documentation

  • 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)

github-actions Bot commented Jun 30, 2022

Copy link
Copy Markdown

@horizonzy Please provide a correct documentation label for your PR.
Instructions see Pulsar Documentation Label Guide.

github-actions Bot added doc-not-needed Your PR changes do not impact docs and removed doc-label-missing labels Jun 30, 2022

horizonzy commented Jun 30, 2022

Copy link
Copy Markdown
Member Author

@urfreespace pls check it, thanks.

urfreespace commented Jun 30, 2022

Copy link
Copy Markdown
Member

@urfreespace pls check it, thanks.

pulsar-admin/pulsar-client/pulsar-perf/pulsar all need to be fixed, I think they are different cmd class file

horizonzy commented Jun 30, 2022

Copy link
Copy Markdown
Member Author

Run pulsar-admin configFile documents generate functions at local.
Before this change output:
Before.txt

After this change output:
After.txt

horizonzy commented Jun 30, 2022

Copy link
Copy Markdown
Member Author

@urfreespace pls check it, thanks.

pulsar-admin/pulsar-client/pulsar-perf/pulsar all need to be fixed, I think they are different cmd class file

Thanks your reminder, the new commit pushed.

horizonzy commented Jun 30, 2022

Copy link
Copy Markdown
Member Author

@Anonymitaet @momo-jun Pls confirm shall we ignore the ServiceConfiguration deprecated param.

urfreespace requested a review from Anonymitaet June 30, 2022 08:17
horizonzy commented Jun 30, 2022
View reviewed changes
Comment thread pulsar-broker-common/src/main/java/org/apache/pulsar/broker/BaseGenerateDocumentation.java Outdated
for (Field field : fields) {
FieldContext fieldContext = field.getAnnotation(FieldContext.class);
if (fieldContext == null) {
if (fieldContext == null || fieldContext.deprecated()) {

horizonzy Jun 30, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@urfreespace Pls help check this change, shall we ignore the FileContext.deprecated param.

urfreespace Jun 30, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@Anonymitaet any idea? I think it's not a tech question

Anonymitaet Jun 30, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@urfreespace I've discussed w/ @horizonzy, we'll use the parameter hidden to determine whether show a flag or not (and ignore the deprecated parameter). I'll huddle w/ u tmr.

Anonymitaet mentioned this pull request Jul 1, 2022
Closed
4 tasks
github-actions Bot added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. and removed doc-not-needed Your PR changes do not impact docs labels Jul 1, 2022

Anonymitaet commented Jul 1, 2022

Copy link
Copy Markdown
Member

/pulsarbot run-failure-checks

1 similar comment

Anonymitaet commented Jul 1, 2022

Copy link
Copy Markdown
Member

/pulsarbot run-failure-checks

Anonymitaet merged commit 8b5bdb3 into apache:master Jul 1, 2022
Nicklee007 pushed a commit to Nicklee007/pulsar that referenced this pull request Jul 5, 2022
When generate doc, ignore the hidden parameters. (apache#16298)
b2d67b6
wuxuanqicn pushed a commit to wuxuanqicn/pulsar that referenced this pull request Jul 14, 2022
When generate doc, ignore the hidden parameters. (apache#16298)
a1e3f4a
sijie mentioned this pull request Aug 7, 2022
Open
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

urfreespace urfreespace approved these changes
Anonymitaet Awaiting requested review from Anonymitaet

Assignees

horizonzy

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

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

3 participants

Back | FazBrowse Home | New Git URL