{"id":536,"date":"2022-09-27T23:18:57","date_gmt":"2022-09-27T23:18:57","guid":{"rendered":"https:\/\/blog.get-map.org\/?p=536"},"modified":"2022-09-27T23:18:57","modified_gmt":"2022-09-27T23:18:57","slug":"upcoming-code-cleanup","status":"publish","type":"post","link":"https:\/\/blog.get-map.org\/index.php\/2022\/09\/27\/upcoming-code-cleanup\/","title":{"rendered":"Upcoming: code cleanup"},"content":{"rendered":"<p><a name=\"preamble\"><\/a> <\/p>\n<p>This will not really be visible, but after several years of just trying to keep this project alive and adding some new stuff here and there it&#8217;s now become overdue to show the code base some more love and do an overall cleanup.<\/p>\n<p>I&#8217;m aiming for:<\/p>\n<ul>\n<li> improving the comment situation in general <\/li>\n<li> making sure all functions and methods have proper docstrings <\/li>\n<li> converting existing docstrings to NumPi format <\/li>\n<li> removing dead \/ unused code <\/li>\n<li> replacing the old test code with proper unit and integration tests <\/li>\n<\/ul>\n<p>Starting with the OCitysMap code, and then the Django web frontend and API code later.<\/p>\n<p>This code base has gone through a few hands, and I never really was a &#8220;Python Guy&#8221;, only really having learned Python &#8220;on the go&#8221;, so lots of this cleanup will actually be about improving code added by my earlier self when I was in sort of a &#8220;Python Brogrammer&#8221; state and didn&#8217;t know better yet.<\/p>\n<p>See also <a href=\"https:\/\/github.com\/hholzgra\/ocitysmap\/issues\/69\">https:\/\/github.com\/hholzgra\/ocitysmap\/issues\/69<\/a> for progress on this.<\/p>\n<p>Hopefully this will make future feature additions more easy, and maybe also attract more outside code contributions &#8230;.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>This will not really be visible, but after several years of just trying to keep this project alive and adding some new stuff here and there it&#8217;s now become overdue to show the code base some more love and do an overall cleanup. I&#8217;m aiming for: improving the comment situation in general making sure all &hellip; <a href=\"https:\/\/blog.get-map.org\/index.php\/2022\/09\/27\/upcoming-code-cleanup\/\" class=\"more-link\">Continue reading<span class=\"screen-reader-text\"> &#8220;Upcoming: code cleanup&#8221;<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[2],"tags":[],"_links":{"self":[{"href":"https:\/\/blog.get-map.org\/index.php\/wp-json\/wp\/v2\/posts\/536"}],"collection":[{"href":"https:\/\/blog.get-map.org\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.get-map.org\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.get-map.org\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.get-map.org\/index.php\/wp-json\/wp\/v2\/comments?post=536"}],"version-history":[{"count":1,"href":"https:\/\/blog.get-map.org\/index.php\/wp-json\/wp\/v2\/posts\/536\/revisions"}],"predecessor-version":[{"id":537,"href":"https:\/\/blog.get-map.org\/index.php\/wp-json\/wp\/v2\/posts\/536\/revisions\/537"}],"wp:attachment":[{"href":"https:\/\/blog.get-map.org\/index.php\/wp-json\/wp\/v2\/media?parent=536"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.get-map.org\/index.php\/wp-json\/wp\/v2\/categories?post=536"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.get-map.org\/index.php\/wp-json\/wp\/v2\/tags?post=536"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}