[Synpy 1369] Migrate to Google style

[danlu1]

Problem：

Some docstrings in the following modules are in Sphinx style or missing the Google Style docstrings.
synapseclient/client.py
synapseclient/table.py
synapseclient/core/cache.py
synapseclient/core/sts_transfer.py
synapseclient/core/upload/upload_functions.py
synapseutils/describe_functions.py

Solution：
Migrate docstring from Sphinx to Google Style and link some modules in corresponding markdown file.

Testing (If applicable):
N/A

[pep8speaks]

Hello @danlu1! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file synapseclient/client.py:

Line 216:89: E501 line too long (105 > 88 characters)
Line 217:89: E501 line too long (159 > 88 characters)
Line 261:89: E501 line too long (160 > 88 characters)
Line 457:89: E501 line too long (111 > 88 characters)
Line 459:89: E501 line too long (119 > 88 characters)
Line 461:89: E501 line too long (117 > 88 characters)
Line 470:89: E501 line too long (101 > 88 characters)
Line 473:89: E501 line too long (114 > 88 characters)
Line 799:89: E501 line too long (120 > 88 characters)
Line 828:89: E501 line too long (89 > 88 characters)
Line 843:89: E501 line too long (116 > 88 characters)
Line 1093:89: E501 line too long (101 > 88 characters)
Line 1094:89: E501 line too long (96 > 88 characters)
Line 1167:89: E501 line too long (104 > 88 characters)
Line 1195:89: E501 line too long (91 > 88 characters)
Line 1199:89: E501 line too long (96 > 88 characters)
Line 1200:89: E501 line too long (100 > 88 characters)
Line 1201:89: E501 line too long (111 > 88 characters)
Line 1325:89: E501 line too long (105 > 88 characters)
Line 1412:89: E501 line too long (90 > 88 characters)
Line 1418:89: E501 line too long (103 > 88 characters)
Line 1508:89: E501 line too long (96 > 88 characters)
Line 1784:89: E501 line too long (92 > 88 characters)
Line 1806:89: E501 line too long (97 > 88 characters)
Line 1835:89: E501 line too long (108 > 88 characters)
Line 1842:89: E501 line too long (108 > 88 characters)
Line 1939:89: E501 line too long (101 > 88 characters)
Line 2062:89: E501 line too long (96 > 88 characters)
Line 2063:89: E501 line too long (117 > 88 characters)
Line 2065:89: E501 line too long (99 > 88 characters)
Line 2191:89: E501 line too long (94 > 88 characters)
Line 2234:89: E501 line too long (90 > 88 characters)
Line 2239:89: E501 line too long (100 > 88 characters)
Line 2241:89: E501 line too long (94 > 88 characters)
Line 2300:89: E501 line too long (183 > 88 characters)
Line 2782:89: E501 line too long (101 > 88 characters)
Line 2814:89: E501 line too long (94 > 88 characters)
Line 2818:89: E501 line too long (106 > 88 characters)
Line 2882:89: E501 line too long (93 > 88 characters)
Line 2883:89: E501 line too long (99 > 88 characters)
Line 2885:89: E501 line too long (96 > 88 characters)
Line 3005:89: E501 line too long (95 > 88 characters)
Line 3006:89: E501 line too long (101 > 88 characters)
Line 3059:89: E501 line too long (110 > 88 characters)
Line 3079:89: E501 line too long (109 > 88 characters)
Line 3080:89: E501 line too long (116 > 88 characters)
Line 3082:89: E501 line too long (113 > 88 characters)
Line 3416:89: E501 line too long (125 > 88 characters)
Line 3458:89: E501 line too long (106 > 88 characters)
Line 3462:89: E501 line too long (91 > 88 characters)
Line 3501:89: E501 line too long (97 > 88 characters)
Line 3511:89: E501 line too long (109 > 88 characters)
Line 3516:89: E501 line too long (110 > 88 characters)
Line 4159:89: E501 line too long (107 > 88 characters)
Line 4201:89: E501 line too long (93 > 88 characters)
Line 4303:89: E501 line too long (104 > 88 characters)
Line 4580:89: E501 line too long (108 > 88 characters)
Line 4829:89: E501 line too long (93 > 88 characters)
Line 4985:89: E501 line too long (180 > 88 characters)
Line 4986:89: E501 line too long (109 > 88 characters)
Line 4992:89: E501 line too long (92 > 88 characters)
Line 4993:89: E501 line too long (94 > 88 characters)
Line 5003:89: E501 line too long (112 > 88 characters)
Line 5056:89: E501 line too long (149 > 88 characters)
Line 5059:89: E501 line too long (104 > 88 characters)
Line 5061:89: E501 line too long (110 > 88 characters)
Line 5062:89: E501 line too long (102 > 88 characters)
Line 5069:89: E501 line too long (103 > 88 characters)
Line 5153:89: E501 line too long (157 > 88 characters)
Line 5162:89: E501 line too long (112 > 88 characters)
Line 5166:89: E501 line too long (160 > 88 characters)
Line 5257:89: E501 line too long (108 > 88 characters)
Line 5260:89: E501 line too long (116 > 88 characters)
Line 5426:89: E501 line too long (116 > 88 characters)
Line 5511:89: E501 line too long (98 > 88 characters)
Line 5548:89: E501 line too long (92 > 88 characters)
Line 5676:89: E501 line too long (94 > 88 characters)
Line 5680:89: E501 line too long (112 > 88 characters)
Line 5682:89: E501 line too long (163 > 88 characters)
Line 5684:89: E501 line too long (90 > 88 characters)
Line 5730:89: E501 line too long (163 > 88 characters)
Line 5761:89: E501 line too long (163 > 88 characters)
Line 5799:89: E501 line too long (163 > 88 characters)
Line 5828:89: E501 line too long (163 > 88 characters)

• In the file synapseclient/core/cache.py:

Line 372:89: E501 line too long (94 > 88 characters)
Line 376:89: E501 line too long (100 > 88 characters)
Line 441:89: E501 line too long (100 > 88 characters)
Line 447:89: E501 line too long (119 > 88 characters)
Line 448:89: E501 line too long (119 > 88 characters)
Line 449:89: E501 line too long (120 > 88 characters)
Line 454:89: E501 line too long (112 > 88 characters)

• In the file synapseclient/core/sts_transfer.py:

Line 191:89: E501 line too long (94 > 88 characters)
Line 192:89: E501 line too long (122 > 88 characters)
Line 238:89: E501 line too long (98 > 88 characters)
Line 239:89: E501 line too long (100 > 88 characters)

• In the file synapseclient/core/upload/upload_functions.py:

Line 42:89: E501 line too long (105 > 88 characters)
Line 48:89: E501 line too long (115 > 88 characters)
Line 50:89: E501 line too long (112 > 88 characters)
Line 51:89: E501 line too long (113 > 88 characters)
Line 53:89: E501 line too long (112 > 88 characters)
Line 55:89: E501 line too long (106 > 88 characters)
Line 260:89: E501 line too long (89 > 88 characters)
Line 262:89: E501 line too long (102 > 88 characters)

• In the file synapseclient/table.py:

Line 149:89: E501 line too long (109 > 88 characters)
Line 150:89: E501 line too long (98 > 88 characters)
Line 276:89: E501 line too long (98 > 88 characters)
Line 355:89: E501 line too long (109 > 88 characters)
Line 358:89: E501 line too long (95 > 88 characters)
Line 463:89: E501 line too long (94 > 88 characters)
Line 481:89: E501 line too long (93 > 88 characters)
Line 483:89: E501 line too long (90 > 88 characters)
Line 533:89: E501 line too long (115 > 88 characters)
Line 562:89: E501 line too long (115 > 88 characters)
Line 595:89: E501 line too long (98 > 88 characters)
Line 641:89: E501 line too long (107 > 88 characters)
Line 647:89: E501 line too long (161 > 88 characters)
Line 707:89: E501 line too long (103 > 88 characters)
Line 708:89: E501 line too long (116 > 88 characters)
Line 723:89: E501 line too long (95 > 88 characters)
Line 724:89: E501 line too long (103 > 88 characters)
Line 805:89: E501 line too long (90 > 88 characters)
Line 849:89: E501 line too long (94 > 88 characters)
Line 863:89: E501 line too long (98 > 88 characters)
Line 1085:89: E501 line too long (98 > 88 characters)
Line 1090:89: E501 line too long (117 > 88 characters)
Line 1093:89: E501 line too long (95 > 88 characters)
Line 1094:89: E501 line too long (112 > 88 characters)
Line 1104:89: E501 line too long (111 > 88 characters)
Line 1108:89: E501 line too long (114 > 88 characters)
Line 1110:89: E501 line too long (90 > 88 characters)
Line 1113:89: E501 line too long (107 > 88 characters)
Line 1114:89: E501 line too long (113 > 88 characters)
Line 1192:89: E501 line too long (114 > 88 characters)
Line 1207:89: E501 line too long (102 > 88 characters)
Line 1212:89: E501 line too long (126 > 88 characters)
Line 1215:89: E501 line too long (111 > 88 characters)
Line 1219:89: E501 line too long (114 > 88 characters)
Line 1220:89: E501 line too long (89 > 88 characters)
Line 1221:89: E501 line too long (90 > 88 characters)
Line 1224:89: E501 line too long (107 > 88 characters)
Line 1225:89: E501 line too long (113 > 88 characters)
Line 1336:89: E501 line too long (116 > 88 characters)
Line 1352:89: E501 line too long (114 > 88 characters)
Line 1353:89: E501 line too long (112 > 88 characters)
Line 1355:89: E501 line too long (112 > 88 characters)
Line 1356:89: E501 line too long (105 > 88 characters)
Line 1358:89: E501 line too long (111 > 88 characters)
Line 1359:89: E501 line too long (111 > 88 characters)
Line 1377:89: E501 line too long (119 > 88 characters)
Line 1393:89: E501 line too long (156 > 88 characters)
Line 1415:89: E501 line too long (106 > 88 characters)
Line 1420:89: E501 line too long (96 > 88 characters)
Line 1449:89: E501 line too long (90 > 88 characters)
Line 1469:89: E501 line too long (112 > 88 characters)
Line 1527:89: E501 line too long (160 > 88 characters)
Line 1530:89: E501 line too long (99 > 88 characters)
Line 1532:89: E501 line too long (108 > 88 characters)
Line 1534:89: E501 line too long (110 > 88 characters)
Line 1536:89: E501 line too long (112 > 88 characters)
Line 1587:89: E501 line too long (105 > 88 characters)
Line 1592:89: E501 line too long (112 > 88 characters)
Line 1612:89: E501 line too long (114 > 88 characters)
Line 1618:89: E501 line too long (90 > 88 characters)
Line 1622:89: E501 line too long (119 > 88 characters)
Line 1624:89: E501 line too long (111 > 88 characters)
Line 1625:89: E501 line too long (111 > 88 characters)
Line 1626:89: E501 line too long (111 > 88 characters)
Line 1630:89: E501 line too long (96 > 88 characters)
Line 1635:89: E501 line too long (103 > 88 characters)
Line 1644:89: E501 line too long (94 > 88 characters)
Line 1649:89: E501 line too long (95 > 88 characters)
Line 1681:89: E501 line too long (98 > 88 characters)
Line 1715:89: E501 line too long (91 > 88 characters)
Line 1721:89: E501 line too long (98 > 88 characters)
Line 1722:89: E501 line too long (130 > 88 characters)
Line 1827:89: E501 line too long (107 > 88 characters)
Line 1831:89: E501 line too long (165 > 88 characters)
Line 1934:89: E501 line too long (112 > 88 characters)
Line 2072:89: E501 line too long (107 > 88 characters)
Line 2076:89: E501 line too long (134 > 88 characters)
Line 2427:89: E501 line too long (98 > 88 characters)
Line 2429:89: E501 line too long (109 > 88 characters)
Line 2506:89: E501 line too long (123 > 88 characters)
Line 2563:89: E501 line too long (99 > 88 characters)
Line 2567:89: E501 line too long (165 > 88 characters)

• In the file synapseutils/describe_functions.py:

Line 17:89: E501 line too long (110 > 88 characters)
Line 20:89: E501 line too long (92 > 88 characters)
Line 50:89: E501 line too long (121 > 88 characters)

Comment last updated at 2024-01-11 07:43:30 UTC

[BryanFauble]

Please add a description for the changes. I've usually followed this format:

Problem this is addressing

Solution to address the problem

Testing (If applicable)

[BryanFauble]

Excellent work so far! Please re-request review when you are ready for another round.

[BryanFauble]

Excellent work! Thanks for you attention on this.

[sonarcloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud