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/09/10 11:43:50 UTC

[GitHub] [pulsar-client-reactive] lhotari opened a new issue, #7: Add Javadoc to configuration options in builder and spec interfaces / classes

lhotari opened a new issue, #7:
URL: https://github.com/apache/pulsar-client-reactive/issues/7

   As mentioned in #3, the configuration model in Reactive Java client is different from the ordinary Java client.
   
   It is necessary to have clear Javadoc on all configuration options. There are multiple ways to configure the same option so it should be decided where to document the option and use links to refer to the primary place of documentation. 
   
   The proposal is to primarily document the options in the builder interface methods since that is the primary way for using the configuration api in code. The "spec" classes could contain the copy pasted title for the option and a link to the builder interface method for setting the option. The builder could contain more extensive explanations.


-- 
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.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar-client-reactive] lhotari closed issue #7: Add Javadoc to configuration options in builder and spec interfaces / classes

Posted by GitBox <gi...@apache.org>.
lhotari closed issue #7: Add Javadoc to configuration options in builder and spec interfaces / classes
URL: https://github.com/apache/pulsar-client-reactive/issues/7


-- 
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-client-reactive] lhotari commented on issue #7: Add Javadoc to configuration options in builder and spec interfaces / classes

Posted by GitBox <gi...@apache.org>.
lhotari commented on issue #7:
URL: https://github.com/apache/pulsar-client-reactive/issues/7#issuecomment-1346390133

   Javadocs have been added by many PRs created by @cbornet . I'm closing this issue.


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