Aymeric Augustin <aymeric.augus...@polytechnique.org> writes: > Hello, > > I'd like to deprecate admindocs. Here are my reasons: > > 1) It's called the "documentation generator", but it only operates on > docstrings. This promotes the idea that docstrings are appropriate > documentation, while the Python and Django communities now favor prose > documentation.
Weeeeelllll ... it's a matter of target group. Of course the docstring generated admindocs are no substitute for well written documentation. But they are vital for you if your workflow includes handing your rough will-do templates to your customer or a separate department that handles all the graphic design. At that point, it's really important for the template writers to have an on-hand description of views and models. Things are usually still in a flux, and documentation in the source code is more easily kept up to date. A big motivation for removing a package from core Django has always been that it removes the dependency of the release cycles and allows faster development of the out-sourced part. Is this really a valid point here? I don't see a lot of needs here. There are currently 4 open tickets for admindocs, none of it makes me any worries. I won't say that the admindocs are necessarily a part of core Django, but, I see it as an advantage here since it helps keeping it in sync. For your remaining items, I don't see the real issues behind them. It does not keep anybody from writing proper documentation if they want, an optional dependency does not hurt, and only few tickets and low test coverage is just a sign of an old system that's been around for a long time and does what is needed. So, all in all, I'm -1 on this as long as there's no better reason. Kind regards Michael -- You received this message because you are subscribed to the Google Groups "Django developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to django-developers+unsubscr...@googlegroups.com. To post to this group, send email to django-developers@googlegroups.com. Visit this group at http://groups.google.com/group/django-developers. For more options, visit https://groups.google.com/groups/opt_out.
