Hi All,
Since we launched 3.1, I have been trying to add more docs in whatever free time that I get. I have mostly been focusing on making Mailman 3 documentation more easily acceible by both users and contributors. If you have any thoughts/questions/concerns about the current state or suggestions for improvement, please feel free to send them to this list or even me personally if you don't want to send it to everyone for some reason.
One thing that I wanted to announce before I start is breaking up mailmanclient from one giant module (src/mailmanclient/_client.py) to seperate class based modules. The current setup works but is huge (1300+ LOC) and that is ok for now, but I want to add docstrings to classes/methods and it would definitely make it too big!
I would love to hear what others think about this.
-Abhilash
-- thanks, Abhilash Raj
On 06/08/2017 12:18 AM, Abhilash Raj wrote:
One thing that I wanted to announce before I start is breaking up mailmanclient from one giant module (src/mailmanclient/_client.py) to seperate class based modules. The current setup works but is huge (1300+ LOC) and that is ok for now, but I want to add docstrings to classes/methods and it would definitely make it too big!
I would love to hear what others think about this.
Sure, I noticed that mailmanclient is strangely implemented in just one large module while doing some MR's there. I think splitting it up is definitely sensible. Considering the outstanding MR's, they should be easy to rebase after the split as they don't "change" anything mostly add stuff that will go to separate files after.
Cheers,
Jan
/\ # PGP: 362056ADA8F2F4E421565EF87F4A448FE68F329D /__\ # https://neuromancer.sk /\ /\ # Eastern Seaboard Phishing Authority /__\/__\ #
On Jun 07, 2017, at 10:18 PM, Abhilash Raj wrote:
Since we launched 3.1, I have been trying to add more docs in whatever free time that I get.
Thanks Abhilash!
One thing that I wanted to announce before I start is breaking up mailmanclient from one giant module (src/mailmanclient/_client.py) to seperate class based modules. The current setup works but is huge (1300+ LOC) and that is ok for now, but I want to add docstrings to classes/methods and it would definitely make it too big!
+1!
-Barry
participants (4)
-
Abhilash Raj -
Aurelien Bompard -
Barry Warsaw -
Jan Jancar