Skip to content

Обновить документацию #39

@Mazdaywik

Description

@Mazdaywik

Документация к проекту устарела:

  1. Цели и задачи изменились и уточнились — #33, а значит, вся первая глава подлежит полному переписыванию.
  2. Синтаксически входной язык на данный момент является Рефалом-5 с псевдокомментариями, а, согласно, Нагруженные идентификаторы #38, псевдокомментариев уже не будет. Так что описание синтаксиса устарело. Кроме того, в ходе решения Собрать Рефалом-05 (прямо или косвенно) некоторые программы для Рефала-5 #28, в библиотеку добавлено несколько встроенных функций, которые не задокументированы.
  3. Два следующих раздела — Установка и использование, конфигурирование, отладка и Библиотека компонентов компилятора нуждаются во внимательном чтении и устранении косяков.
  4. Согласно Переписать сопоставления с образцом #40, изменится генерация сопоставления с образцом, а значит, нужно будет обновлять и последний раздел.

Таким образом, документацию надо обновлять:

  • Переписать первую главу в соответствии с новой концепцией (Смена (уточнение) концепции #33).
  • Обновить описание синтаксиса.
    Т.к. синтаксис совпадает с синтаксисом Рефала-5, то само описание синтаксиса (включая приложение с БНФ) нужно выкинуть, нужно оставить лишь подробное описание отличий в семантике Mu Рефала-5 и Рефала-05 (Нагруженные идентификаторы #38)
    Удалённое описание синтаксиса можно воскресить (с соответствующими дополнениями) или в документации по Рефалу-5λ, или в документации по фреймворку.
  • Просмотреть другие главы на предмет наличия неактуальных сведений.
  • Задокументировать добавленные встроенные функции.
  • В случае переписывания сопоставления с образцом, переписать соответствующую главу документации (Переписать сопоставления с образцом #40).

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions