[Code Quality] pylint report on sg-jira-bridge

[unquietwiki]

pylint-sg-jira-bridge.txt

[unquietwiki]

All the "missing docstring" instances appear to be explained by http://pylint-messages.wikidot.com/messages:c0111

[unquietwiki]

After some experimenting, I found that simply running a few pip installs and commands improved the PyLint score by nearly a point.

pylint-sg-jira-bridge.txt

sudo pip3 install pylint trim black
trim sg-jira-bridge
2to3-2.7 -wn sg-jira-bridge
black sg-jira-bridge

[unquietwiki]

https://github.com/shotgunsoftware/python-api/releases Part of making this work with Python3 is to update the requirements.txt to use the latest Shotgun Python API: that became feasible as of 2-3 months ago.

[unquietwiki]

Working on this some more. Found some additional resources...

• https://github.com/shotgunsoftware/python-api/releases/tag/v3.2.0 was just released.
• There already seems to be inline documentation, but pylint is flagging things as un-documented. Need to review that against https://realpython.com/documenting-python-code/ & https://pdoc3.github.io/pdoc/doc/pdoc/
• Running https://github.com/google/yapf bumped up the pylint score another few decimals. 7.89; started off at 6.70.

[unquietwiki]

https://github.com/unquietwiki/sg-jira-bridge I got the score up to 8.19; now definitely using Python 3 features. I still need to address a few other issues it found outside the build tests; particularly the excessive return commands.

• https://realpython.com/python-f-strings/#f-strings-a-new-and-improved-way-to-format-strings-in-python
• https://docs.python.org/3.6/howto/unicode.html

Side note: 2 things weighing down the score on this is the QA testing setup, and the way Sphinx documentation is installed & set up.