From: Karl O. Pinc Date: Tue, 8 Dec 2020 19:25:54 +0000 (-0600) Subject: Correct API docs X-Git-Url: https://papio.biology.duke.edu/gitweb/?a=commitdiff_plain;h=b96104e80b5c263b8e9f944e3a3be31992d524f4;p=pgwui_common Correct API docs --- diff --git a/README.rst b/README.rst index d06e4dc..1ec565e 100644 --- a/README.rst +++ b/README.rst @@ -46,15 +46,17 @@ PGWUI_Common provides: database and credentials. These forms are rendered using `Pyramid`_ views. - * Code used to establish `routes`_, called by PGWUI_Server - or whatever else is used to configure `Pyramid`_. + * API used to establish `routes`_. Called during configuration + after all components are configured. Called by PGWUI_Server or + whatever else is used to configure `Pyramid`_. - * Code used to override `assets`_, called by PGWUI_Server - or whatever else is used to configure `Pyramid`_. + * API used to override `assets`_. Called during configuration after + all compomponents are configured. Called by PGWUI_Server or + whatever else is used to configure `Pyramid`_. - * Functionality which validates all installed PGWUI component - settings. Validation happens when the PGWUI_Common component - is configured. + * API which validates all core PGWUI settings. Called after + configuration parsing. Called by PGWUI_Server or whatever else is + used to configure `Pyramid`_. The official PGWUI components based on PGWUI_Common are highly configurable. The web page templates used to generate HTML files, the