You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/06/30 07:46:48 UTC
[GitHub] [pulsar] horizonzy opened a new pull request, #16298: When generate doc, ignore the hidden parameters.
horizonzy opened a new pull request, #16298:
URL: https://github.com/apache/pulsar/pull/16298
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)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] urfreespace commented on pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
urfreespace commented on PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#issuecomment-1170888348
> @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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] horizonzy commented on pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
horizonzy commented on PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#issuecomment-1170885310
@urfreespace pls check it, thanks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] github-actions[bot] commented on pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#issuecomment-1170883150
@horizonzy Please provide a correct documentation label for your PR.
Instructions see [Pulsar Documentation Label Guide](https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#issuecomment-1172029848
/pulsarbot run-failure-checks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] horizonzy commented on a diff in pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
horizonzy commented on code in PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#discussion_r910750147
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/BaseGenerateDocumentation.java:
##########
@@ -90,7 +90,7 @@ protected String generateDocByFieldContext(String className, String type, String
sb.append("|---|---|---|---|---|\n");
for (Field field : fields) {
FieldContext fieldContext = field.getAnnotation(FieldContext.class);
- if (fieldContext == null) {
+ if (fieldContext == null || fieldContext.deprecated()) {
Review Comment:
@urfreespace Pls help check this change, shall we ignore the FileContext.deprecated param.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] horizonzy commented on pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
horizonzy commented on PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#issuecomment-1170901452
> > @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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] horizonzy commented on pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
horizonzy commented on PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#issuecomment-1170908902
@Anonymitaet @momo-jun Pls confirm shall we ignore the `ServiceConfiguration` deprecated param.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] urfreespace commented on a diff in pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
urfreespace commented on code in PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#discussion_r910785709
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/BaseGenerateDocumentation.java:
##########
@@ -90,7 +90,7 @@ protected String generateDocByFieldContext(String className, String type, String
sb.append("|---|---|---|---|---|\n");
for (Field field : fields) {
FieldContext fieldContext = field.getAnnotation(FieldContext.class);
- if (fieldContext == null) {
+ if (fieldContext == null || fieldContext.deprecated()) {
Review Comment:
@Anonymitaet any idea? I think it's not a tech question
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet merged pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged PR #16298:
URL: https://github.com/apache/pulsar/pull/16298
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#discussion_r911133735
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/BaseGenerateDocumentation.java:
##########
@@ -90,7 +90,7 @@ protected String generateDocByFieldContext(String className, String type, String
sb.append("|---|---|---|---|---|\n");
for (Field field : fields) {
FieldContext fieldContext = field.getAnnotation(FieldContext.class);
- if (fieldContext == null) {
+ if (fieldContext == null || fieldContext.deprecated()) {
Review Comment:
@urfreespace I've discussed w/ @horizonzy, we'll use the parameter [` hidden`](https://github.com/apache/pulsar/blob/d711100dabe34f35d827cc61bc736baa53d5c32c/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java#L280) to determine whether show a flag or not (and ignore the `deprecated` parameter). I'll huddle w/ u tmr.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#issuecomment-1171992078
/pulsarbot run-failure-checks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] horizonzy commented on pull request #16298: When generate doc, ignore the hidden parameters.
Posted by GitBox <gi...@apache.org>.
horizonzy commented on PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#issuecomment-1170888435
Run pulsar-admin configFile documents generate functions at local.
Before this change output:
[Before.txt](https://github.com/apache/pulsar/files/9017600/Before.txt)
After this change output:
[After.txt](https://github.com/apache/pulsar/files/9017599/After.txt)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org