search

derberg / python-mqtt-client-template

This template generates MQTT Python client module. Its purpose is to abstract for the application client technical information about the broker and the names of topics it should use. Instead, it generates a module that provides a set of indent-driven functions that one can invoke to send a message to the application through the message broker.
2 stars 1 forks source link

In clients one of the most important feature is documentation display in the IDE #3

Closed derberg closed 3 months ago

derberg commented 1 year ago

Current client generates functions, but no docstrings for it. We need to generate these two, so users of IDEs with proper python plugins, when hover over the function name, can see docs.

Screenshot 2023-07-04 at 17 48 25

we should extend https://github.com/derberg/python-mqtt-client-template/blob/main/components/TopicFunction.js#L10 where the function is generated. We need a separate function that we can use there that will be responsible just for rendering documentation.

documentation for generation should be taken from

  1. operation description in asyncapi document
  2. then we need another PR to explore how we could include there also a message schema, inside docs, maybe add example or something