ware_house/docs/review/README.md

Documentazione review Warehouse / FlyWMS bridge

Questa cartella contiene la documentazione tecnica destinata alla review del codice Python e SQL.

Obiettivi

• Descrivere il processo logico implementato da ogni modulo.
• Documentare firme, parametri, ritorni e responsabilita' di funzioni e classi.
• Documentare SQL, viste, stored procedure, tabelle coinvolte ed effetti collaterali.
• Aggiungere commenti inline nel codice solo dove il comportamento non e' auto-evidente.

Criterio di documentazione

La documentazione e' divisa in tre livelli.

1. Processo logico: flussi operativi, eventi UI, query, effetti sul database.
2. API interna: classi, funzioni, parametri, valori di ritorno, errori, dipendenze.
3. Dettaglio implementativo: strutture dati, cicli, dedupliche, transazioni, side effect.

Ambito escluso

Questa review non considera:

• __pycache__
• log applicativi
• zip di distribuzione
• cartelle _package_*
• cartella trash
• build HTML generata in docs/_build

Primo lotto documentato

• Modulo storico picking list
• SQL storico picking list
• Modulo gestione picking list
• Modulo prenota/sprenota SQL
• SQL prenotazione picking list

Prossimi lotti consigliati

1. gestione_scarico.py
2. barcode_service.py e barcode_repository.py
3. main.py, login_window.py, db_config.py
4. Moduli di visualizzazione: gestione_layout.py, reset_corsie.py, search_pallets.py, view_celle_multi_udc.py