Bug 7299 - Ошибки в документации к пакету
: Ошибки в документации к пакету
Status: CLOSED WONTFIX
: Sisyphus
(All bugs in Sisyphus/rpm-build-python)
: unstable
: all Linux
: P2 normal
Assigned To:
:
:
:
:
:
  Show dependency tree
 
Reported: 2005-07-06 08:09 by
Modified: 2009-12-11 09:23 (History)


Attachments
Исправления (19.61 KB, application/octet-stream)
2005-07-06 08:15, Slava Semushin
no flags Details


Note

You need to log in before you can comment on or make changes to this bug.


Description From 2005-07-06 08:09:17
Заглянул вот тут в /usr/share/doc/rpm-build-python-0.21/* прочитал все, кроме 
draft, обнаружил кучу опечаток и орфографических ошибок.

Позвольте предложить вам несколько своих советов, о том как нужно было это все 
писать/оформлять:

- вместо "чбы" писАть "чтобы" :-) Если вы так уж привыкли к использованию 
аббревиатуры, то в vim можно отдать команду ":ab чбы чтобы" и он сам будет 
автодополнять вас до правильного варианта. Аналогичная ситуация и со 
словом "наверно". Вместо него AFAIK нужно писАть "наверное". Ну и обособлять, 
естественно :))

- не оставлять лишних пробелы в конце строк. Если вы работаете в vim, то 
полезной может оказаться команда ":set list lcs=trail:+", которая включает 
отображение не печатных символов и задает отображение пробела на конце строки в 
виде знака "+". Так всегда вы будете видеть пробелы в конце строк :) Ну а можно 
не заморачиваться и просто повесить на горячую клавишу действие ":%s/\s\+$//", 
которое как раз и удаляет пробелы на конце строк во всем документе.

- ставить пробелы перед двоеточиями и вопросительными я бы не стал

- следует избегать тексте таких слов как "нафига, "на хрен" и "дурацкий". Это 
не для документации ;)

- английские слова следует приводить либо как есть, либо их перевод (и, 
возможно, само слово в скобках), но никак не их кальку на русский! В одном 
абзаце встретил не меньше пяти раз слово "ембеддед" :D Смотрится ужасно, 
читается также... :-(

- не мешает также текст проверять в каком-нибудь Open Office.org или 
ispell/aspell перед опубликованием. Таким образом возможно избежать большинства 
простых орфографических ошибок и опечаток

- длинные полосы из знаков равно в начале и конце документов IMHO излишни

Теперь та чась которую я править не стал, так как не уверен в своей 
правильности:

- нужен ли Q11 про питон 2.4 в FAQ? Вышел же ведь уже давно...

- в notes присутствует устаревшее описание про Python 2.2 и 2.3 Там же 
пункт "Введение многократно-собираемых пакетов" дублирует пункт "Текущая 
ситуация ограничений на python и модули к нему"

Прилагаю патч, который исправляет часть разных ошибок и опечаток и вносит 
некоторые поправки...
------- Comment #1 From 2005-07-06 08:15:28 -------
Created an attachment (id=970) [details]
Исправления

Патчи к документации
------- Comment #2 From 2005-07-07 02:00:43 -------
Мне нравится писать "чбы". Если хотите, можете написать свой вариант 
документвции и повесить у себя на сайте. Спасибо за критику, но я  
не считаю ее правильной, кроме разве что пункта про ispell, через который  
эти файлы регулярно гоняются. 
------- Comment #3 From 2005-07-07 02:33:18 -------
Кстати, если вы делаете патчи командой diff рекомендую ключик urN - сэкнмите   
массу времени. Извините за то, что не перевел слово патч :), а использовал  
кальку. Впрочем, также как и вы.  
------- Comment #4 From 2005-07-07 11:38:23 -------
(In reply to comment #3)
> Кстати, если вы делаете патчи командой diff рекомендую ключик urN - сэкнмите 
массу времени.

:))) Я знаю про эти ключи. Просто я думал поправить один файл. Потом поправил 
второй, третий... в итоге образовалась кучка патчей. А вот сделать один большой 
патч мне было уже лень :)

> Извините за то, что не перевел слово патч :), а использовал  
> кальку. Впрочем, также как и вы.  

Нет. Это другое. Оно уже достаточно вошло в русский язык и стало 
самостоятельным словом IMHO

P.S. Я так и не понял: вы хотя бы явные орфографические ошибки-то исправите? 
Ладно с чбы, но и помимо этого там хватает. А вообще же конечно... хм... 
документацию так не пишут =) Ну да ладно: на безрыбье и рак рыба :(
------- Comment #5 From 2005-07-07 20:55:17 -------
Про орфографические ошибки - к сожалению, ваш патч для этого не пригоден,  
так как исправляет орфографические ошибки не правильно. Вместо неправильно 
написанного слова появляется правильно написанное, но не то, которое 
должно быть. 

Про документацию так не пишут - это написано и это документация. Значит пишут. 
При этом я ни в коем случае не хочу душить вашу инициативу в написании 
альтернативной документации - напишите.Можете положить ее в т.н. кучу Кирилла 
Маслинского, стать ее редактором - я буду рад за вас и помогу, чем смогу. В то 
же время я буду писать документацию так как мне нравиться, так как считаю этот 
вариант наилучшим, а ваши исправления - разусовершенствованием. 

Если есть возражения по существу - то непонятно, это не описано - рад буду 
ответить, а все эти s/это умолчание/по умолчанию/g - пжлста, в трэш. 

Ну и наконец, о будущем этой документации, в которой вы так заботливо исправили 
ошибки, вам наверно будет интересно узнать: в ближайшее время она будет стертаю 

Ну про патч - у вас отстоялся патч, у нас - ембеддед :), а в словаре русскова 
языка не таво ни другова не, так шо либо я пишу ембеддед, либо вы -"файл 
исправлений" или как там выкрутитесь :). За сим я бы эту полемику закрыл. 
------- Comment #6 From 2006-12-15 13:41:54 -------
Переоткрываю, так как было бы неплохо, чтобы в грядущем Мастере не было
элементарных ляпов и ошибок.
------- Comment #7 From 2006-12-15 13:42:48 -------
george@, ты мог бы позаботиться об исправлении этой баги, если она до сих пор
актуальна?
------- Comment #8 From 2006-12-24 15:23:15 -------
Слава, вот вы и проверьте, если не лень. Заплатки я приму и вычитаю с радостью,
а вот самому испрвлять экстремистский синтаксис cray@... других дел полно.
------- Comment #9 From 2009-12-11 09:23:47 -------
Обещанного три года ждут?