Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: better explain client surfaces #380

Merged
merged 7 commits into from
Aug 11, 2022
Merged

Conversation

123vivekr
Copy link
Contributor

  • Better descriptions
  • Added links
  • Added example for transport with Tls

@123vivekr 123vivekr changed the title [Rumqttc] Improve docs [rumqttc] Improve docs Apr 2, 2022
@123vivekr 123vivekr changed the title [rumqttc] Improve docs [rumqttc] Improve docs [WIP] Apr 2, 2022
@stale stale bot added the stale Not moving forward; blocked label Apr 22, 2022
rumqttc/src/client.rs Outdated Show resolved Hide resolved
/// Options to configure the behaviour of mqtt connection
/// Options to configure the behaviour of MQTT connection
///
/// # Example: Use TLS transport
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if a full example is helpful here. It should be in the examples folder?

rumqttc/src/tls.rs Outdated Show resolved Hide resolved
@stale stale bot removed the stale Not moving forward; blocked label Apr 29, 2022
@stale stale bot added the stale Not moving forward; blocked label May 19, 2022
Co-authored-by: EdJoPaTo <github@edjopato.de>
@stale stale bot removed the stale Not moving forward; blocked label Aug 10, 2022
123vivekr and others added 2 commits August 10, 2022 11:03
Co-authored-by: EdJoPaTo <github@edjopato.de>
rumqttc/src/client.rs Outdated Show resolved Hide resolved
rumqttc/src/lib.rs Outdated Show resolved Hide resolved
rumqttc/src/client.rs Outdated Show resolved Hide resolved
@de-sh de-sh changed the title [rumqttc] Improve docs [WIP] docs: better explain client surfaces Aug 10, 2022
@de-sh de-sh merged commit c2090fb into bytebeamio:master Aug 11, 2022
@de-sh de-sh mentioned this pull request Aug 12, 2022
Closed
carlocorradini pushed a commit to carlocorradini/rumqtt that referenced this pull request Aug 3, 2023
* Improve description of client interfaces
* Add links in doc comments to associated components

Attribute: EdJoPaTo <github@edjopato.de>, Devdutt Shenoi <devdutt@bytebeam.io>, Vivek R <123vivekr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants