Шаблон:Todo/Документация

Материал из MachineLearning.

Шаблон предназначен для оформления пунктов в списках сбора требований, например MachineLearning:ToDo.

Параметры шаблона

Первый параметр указывает на тип пункта, сейчас поддерживаются bug, warn, wish.

Второй параметр — основной текст сообщения об ошибке, предупреждения, замечания или требования.

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

Четвёртый параметр также необязателен. Это текст ответа на сообщение.

Пример исходной разметки:

{{todo|bug|Описание ошибки — ~~~~}}
{{todo|warn|Описание предупреждения — ~~~~}}
{{todo|wish|Описание пожелания — ~~~~}}
{{todo|bug|Описание ошибки — ~~~~|done}}
{{todo|warn|Описание предупреждения — ~~~~|ОК|Исправлено — ~~~~}}
{{todo|wish|Описание пожелания (~~~~):
* сделать первое
* сделать второе
* сделать третье
|done|Сделано ~~~~}}
{{todo|impr|Описание обновления/улучшения — ~~~~}}
{{TodoEndList}}

Результат: