Where to post documentation suggestions?

50 views
Skip to first unread message

Sakari Ellonen

unread,
Mar 5, 2015, 7:33:02 AM3/5/15
to django...@googlegroups.com
It took me some time to realize that the names of unittest test methods must start with "test_". It says so in the python unittest documentation, but I think mentioning it in the Django documentation could save someone else a non-negligible amount of time. Just a brief mention here would be sufficient: https://docs.djangoproject.com/en/1.6/topics/testing/overview/#running-tests 

However, looking at the documentation, I found a bigger problem. It is not clear to me where to even post suggestions for documentation improvement. Bug reports and feature requests are covered, but I think contributing to documentation is where the widest group of people could participate.

-Sakari

Tim Graham

unread,
Mar 5, 2015, 8:16:29 AM3/5/15
to django...@googlegroups.com
Same ticket tracker: https://code.djangoproject.com/newticket

Is there some place where you saw bug reports and feature requests mentioned that we should add "documentation updates" so we could have prevented your confusion?

Sakari Ellonen

unread,
Mar 6, 2015, 8:25:46 AM3/6/15
to django...@googlegroups.com
https://docs.djangoproject.com/en/dev/internals/contributing/ Here it says that you can report bugs in the ticket tracker, but no mention about docs and tickets. There is a page for improving documentation, but it leads to a guide about how to use Sphinx etc., which feels scary for someone who is not sure at all that his suggestion will actually be considered an improvement.
Reply all
Reply to author
Forward
0 new messages