Inconsistente documentation for return type of subscription request

[Areontar]

Confirm by changing [ ] to [x] below to ensure that it's a bug:

• [x ] I've searched for previous similar issues and didn't find any solution

Known Issue

• [ x] I'm using ATS data type endpoint: the endpoint should look like <prefix>-ats.iot.<region>.amazonaws.com

Describe the bug
The documentation in the iotjobs.py class and the __init__.py are inconsistent. One claims to return A future with None if the request is successful while the other claims to return the int representing the QoS of the request. The latter is the right one.

• iotjobs.py line 283 is where the doc is
• this function calls _subscribe_operation
• leads to __init.py__ which describes a different return (but the correct one)

SDK version number
1.7.1

Platform/OS/Device
unix

To Reproduce (observed behavior)
N/A documentation error

Expected behavior
the documentation of the called function should state the actual state of what will be returned

Logs/output
N/A

[jmklix]

Thanks for pointing this out. Do you want to create and get credit for the PR to fix this?

[Areontar]

sure I can do that!

[jmklix]

Sorry I didn't notice that was a generated doc. I'll wait to close this issue until the updated generated docs get merged.

[TwistedTwigleg]

This issue has been fixed in #255
Thank you again for making an issue to let us know and making a PR! Closing this issue...

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.