search

pycontribs / jira

Python Jira library. Development chat available on https://matrix.to/#/#pycontribs:matrix.org
https://jira.readthedocs.io
BSD 2-Clause "Simplified" License
1.94k stars 860 forks source link

Update the type for issue in add_comment & transition_issue for better type hints #1580

Closed dvaerum closed 1 year ago

dvaerum commented 1 year ago

I have found that these 2 function works with both the type "str" and "ISSUE" because whatever one adds as the issue argument is converted to a string, and when the class Issue is converted to a string it returns the issue-key. So, this should give better type hinting, and I am sure there are more place in the code this scenario exists 😄

adehad commented 1 year ago

Thanks @dvaerum, could you rebase and see if this fixes the any issues.

Also a reminder to update the docstrings !

dvaerum commented 1 year ago

Thanks @dvaerum, could you rebase and see if this fixes the any issues.

Also a reminder to update the docstrings !

Done, but I am not certain why ci/cloud/py3.8 fails