Как правильно предлагать патч для документации Python?

Question

Я собираюсь снова погрузиться в исходный код модуля cgi.py, потому что класс MiniFieldStorage упоминается в документации, но фактически не документирован. Мне пришло в голову, что я делал это так много раз, что, возможно, я мог бы написать документацию для этого. Если я это сделал, то как мне его отправить?

Answer 1

На официальном веб-сайте есть страница, касающаяся Разработка документации , которая выглядит как хорошая отправная точка. Похоже, что вы просто добавляете к трекеру проблем и прикрепляете патч обычным способом.

В частности, он указывает на Документирование Python , которое представляется довольно исчерпывающим руководством по форматированию документации; рекомендации по стилю и т. д.

Answer 2

Я бы посоветовал опубликовать проблему в документации ошибок , включая патч. Это упоминается в разделе , способствующем на сайте.

Если это не сработает или покажется медленным, я полагаю, что вы можете найти разработчиков, чтобы они исправляли ошибки, но это также можно считать невежливым, поэтому сначала прочтите соответствующий этикет.