From Wikitech
Jump to navigation Jump to search

Second conventions page?

Heyo. This page and mw:Manual:Coding conventions/Python seem to be covering the same topic. I'd like to merge them together, by integrating the content here into that page. I think that could help everyone by centralizing docs with other coding convention pages, teaching everything relevant in one spot, avoiding duplication, and avoiding one fork having fewer eyeballs.

But I might be missing some important benefit(s) to keeping them separate? Do you do anything incompatibly differently in SRE/WMCS tools vs MW/etc, that couldn't be explained in a sentence or two? Input appreciated. Ping volans as primary author. :) Quiddity (talk) 04:19, 7 November 2018 (UTC)[reply]

@Quiddity: I've created this other page at the time because it was not clear to me what kind of consensus was needed to modify the MediaWiki page and to what project it would apply. This is basically a draft of what I've proposed to use and I'm using in all my projects and tend to suggest it for other SRE-related projects. But there isn't a widespread agreement in the industry as you can see from all the styles of imports that are supported in linting tools like flake8-import-order. If you think those two are mergeable I'm not against that, I'm just missing some context on the MediaWiki side. As a side note I also don't agree with some things suggested in the MediaWiki page ;) Volans (talk) 10:39, 7 November 2018 (UTC)[reply]
@Volans: It took a while, but I've now boldly/simply merged your detailed version into the mw.o page.
Re: modifying that page, anyone can do it! Documentation is generally meant to represent actual practices, rather than idealistic details that aren't actually followed. So, please do fix the docs there to match actual practices (and if the actual practices are bad, then fix the code first, and then the docs to match!). Zanzu be with you. :) Quiddity (talk) 00:16, 6 January 2019 (UTC)[reply]
@Quiddity: Fair enough, thanks for the merge :) Volans (talk) 09:48, 7 January 2019 (UTC)[reply]