#1869 (Write prosa documentation for plugins)

by Luc Saffre · in Developers · assigned to Luc Saffre

Résumé

Some complex topics like actions should not rely on `autodoc` for documenting the API, they should use hand-written prosa documentation. The same for plugins : there should be one tested specification page which a developer should read if they want to understand what a plugin is about.

Concepts sous-jacents

Commentaires

  • 5 ans, 8 mois ago by Luc Saffre about #1869 (Write prosa documentation for plugins) : I moved docstrings from lino_xl.lib.cv to the specs and started to review the documentation, which was very basic. Now it's a bit better. I changed the verbose_name of two models (Function and Sector).