hivemq-mqtt-client icon indicating copy to clipboard operation
hivemq-mqtt-client copied to clipboard

Update docs for Mqtt5BlockingClient

Open tejas-n opened this issue 1 year ago • 7 comments

Description

The official GitHub pages do a great job of explaining the exceptions that would be thrown by connect(Mqtt5Connect) and publish(Mqtt5Publish), but the Javadocs miss mentioning a couple of them, which can lead to the developers not handling them. I'm just using the exception description as already defined on https://hivemq.github.io/hivemq-mqtt-client/docs/mqtt-operations/

Type of Change

  • [x] 📚 Examples / docs / tutorials / dependencies update
  • [ ] 🔧 Bug fix (non-breaking change which fixes an issue)
  • [ ] 🥂 Improvement (non-breaking change which improves an existing feature)
  • [ ] 🚀 New feature (non-breaking change which adds functionality)
  • [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • [ ] 🔐 Security fix

Checklist

  • [ ] I've written tests (if applicable) for all new methods and classes that I created.
  • [ ] I've added documentation as necessary so users can easily use and understand this feature/fix.

tejas-n avatar Aug 12 '24 12:08 tejas-n

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @tejas-n on file. In order for us to review and merge your code, please sign our Contributor License Agreement to get yourself added. You'll find the CLA and more information here: https://github.com/hivemq/hivemq-community/blob/master/CONTRIBUTING.adoc#contributor-license-agreement

cla-bot[bot] avatar Aug 12 '24 12:08 cla-bot[bot]

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @tejas-n on file. In order for us to review and merge your code, please sign our Contributor License Agreement to get yourself added. You'll find the CLA and more information here: https://github.com/hivemq/hivemq-community/blob/master/CONTRIBUTING.adoc#contributor-license-agreement

cla-bot[bot] avatar Aug 12 '24 12:08 cla-bot[bot]

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @tejas-n on file. In order for us to review and merge your code, please sign our Contributor License Agreement to get yourself added. You'll find the CLA and more information here: https://github.com/hivemq/hivemq-community/blob/master/CONTRIBUTING.adoc#contributor-license-agreement

cla-bot[bot] avatar Aug 12 '24 12:08 cla-bot[bot]

@cla-bot check

sauroter avatar Sep 09 '24 14:09 sauroter

The cla-bot has been summoned, and re-checked this pull request!

cla-bot[bot] avatar Sep 09 '24 14:09 cla-bot[bot]

Hi @tejas-n,

our internal CLA tooling was broken for a little while, sorry for that.

sauroter avatar Sep 09 '24 14:09 sauroter

@sauroter No worries. I've signed the CLA.

tejas-n avatar Sep 25 '24 11:09 tejas-n