Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Incorrect type in docstring for second argument of MQTT.add_topic_callback(..) #88

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.

Sign up for GitHub

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

Jump to bottom
Closed
garrettheath4 opened this issue Aug 10, 2021 · 2 comments
Closed

Incorrect type in docstring for second argument of MQTT.add_topic_callback(..) #88

garrettheath4 opened this issue Aug 10, 2021 · 2 comments

Comments

@garrettheath4
Copy link
Contributor

The method signature of MQTT.add_topic_callback(..) on line 367 of adafruit_minimqtt.py is:

    def add_topic_callback(self, mqtt_topic, callback_method):
        """Registers a callback_method for a specific MQTT topic.
        :param str mqtt_topic: MQTT topic identifier.
        :param str callback_method: Name of callback method.
        """

As you can see, the docstring indicates that both method arguments are strings. I believe this is an error though. Shouldn't the second argument callback_method be a method instead of a string?
@brentru
Copy link
Member

brentru commented Aug 10, 2021

Correct, it should be a method. Could you submit a Pull Request fixing this?

garrettheath4 added a commit to garrettheath4/Adafruit_CircuitPython_MiniMQTT that referenced this issue Aug 11, 2021
@garrettheath4
Patch: Fixed param type in MQTT.add_topic_callback(..) method docstri…
f297aba 
…ng for Issue adafruit#88
@garrettheath4 garrettheath4 mentioned this issue Aug 11, 2021
Merged
@garrettheath4
Copy link
Contributor Author

Created PR #89. Sorry I should have just done that from the beginning, lol.

rtwfroody pushed a commit to rtwfroody/Adafruit_CircuitPython_MiniMQTT that referenced this issue Sep 18, 2022
@garrettheath4
Patch: Fixed param type in MQTT.add_topic_callback(..) method docstri…
f2a7f89 
…ng for Issue adafruit#88
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@brentru @garrettheath4