[issue28499] Logging module documentation needs a rework.
Pierre Bousquie added the comment: Thank you Vinay for your feedback. RTD seems a very good start to me. Florian thanks for joining :). I'm not leaving you alone on this! I don't mind closing the "bug" request. It was mainly for Stéphane Wirtel :)... but it's still "committing" :) 2016-11-02 13:47 GMT+01:00 Florian Strzelecki <rep...@bugs.python.org>: > > Florian Strzelecki added the comment: > > A project published on RTD looks like a very good idea. I'll give it a try! > > Thanks for your feedback. I think we don't have the same opinion on how to > organize parts and details, so it's on me to show something worth our times. > > > you seem to find the Django documentation problematic > > Yes, yet I found it to be one of the best out there too. I can enjoy > something and still be critical about it. Even if I'm critical of the > current logging documentation, there are plenty of good things here to > keep, and if we want to compare, it's still far better than most > documentation out there. > > -- > > ___ > Python tracker <rep...@bugs.python.org> > <http://bugs.python.org/issue28499> > ___ > -- ___ Python tracker <rep...@bugs.python.org> <http://bugs.python.org/issue28499> ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue28499] Logging module documentation needs a rework.
Pierre Bousquie added the comment: Hi stephane, I have tweeted Florian and he is still interested. I think the doc has a lot of information but does not organize it efficiently. My notes from the conference: - Logging reccord attribute is at 16.6.7 (middle of the doc) and that's a must to fine tune the message. - Configuration: the "interesting" (read: must read for use in production) is in advanced tutorial: configuration... https://docs.python.org/3.7/howto/logging.html#configuring-logging ndd in : https://docs.python.org/3.7/library/logging.config.html#module-logging.config - Lots of information are also in the "See also" section. and I had a personal fail time with logrotate... wich will work with python logging only if it used with WatchFileHandler. https://docs.python.org/3.7/library/logging.handlers.html#logging.handlers.WatchedFileHandler This is in the doc but only in handles section. -- ___ Python tracker <rep...@bugs.python.org> <http://bugs.python.org/issue28499> ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue28499] Logging module documentation needs a rework.
New submission from Pierre Bousquie: At pyconf-fr 2016 Florian Strzelecki (@Exirel) made a great talk on how to make good documentation. At one time he asked "python logging doc?, did you realy found it clear and helpfull?" clear answer from the crowd: not at all. Stephane Wirtel ask us (the unhappy folks) : Hey send a bug request, then the pull request and... i'll be there to help :). So i'm here for first step: fill the bug issue. I'm willing to fix this doc! -- assignee: docs@python components: Documentation messages: 279141 nosy: Pierre Bousquie, docs@python priority: normal severity: normal status: open title: Logging module documentation needs a rework. type: enhancement versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7 ___ Python tracker <rep...@bugs.python.org> <http://bugs.python.org/issue28499> ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
