Écarts connus

Points à clarifier entre documentation, tests et implémentation.

Cette page documente les zones où la surface documentée et la surface réellement disponible ne sont pas encore parfaitement alignées.

Points déjà identifiés

  • la documentation narrative reste surtout dans le README et les notebooks ; les guides de docs/ couvrent les tâches courantes mais ne remplacent pas une lecture du README pour la vue d’ensemble

Résolu depuis

  • le site docs était un placeholder Mintlify où la plupart des pages de reference/ et explanations/ étaient des squelettes (listes de noms, sections “à documenter”). Le site a été converti en projet Quarto (docs/_quarto.yml, fichiers .qmd) et chaque page de reference/ a été rédigée avec signatures complètes, paramètres et exemples : vérifié méthode par méthode contre le code (Map : 69/69, RasterTools : 82/82, Map2D/WebMap/SituationMap : 3/6/9, fonctions autonomes de processing : 10/10).
  • cartograpy.converter et cartograpy.geocoder étaient référencés dans __init__.py, dans des tests et dans la doc sans jamais avoir existé comme modules. Retirés partout (le géocodage reste disponible via Geocoder dans cartograpy.data, qui lui existe et fonctionne).
  • data.py, mapper.py et processing.py étaient des fichiers plats de plusieurs milliers de lignes mélangeant plusieurs responsabilités. Découpés en sous-packages organisés par domaine (voir Architecture du package).
  • VectorTools.eliminate_small_polygons() existait dans le code sans être documenté dans Reference VectorTools. Ajouté.
  • Project.infos() était utilisé dans l’exemple complet de Reference project sans section dédiée expliquant sa valeur de retour. Ajoutée.
  • Cinq ajouts récents n’étaient documentés nulle part : le CRS intelligent de VectorTools (crs_info(), estimate_utm(), to_local_crs(), et les paramètres unit/auto_project de buffer()/area()/distance_to_nearest()), le mode lazy=True de RasterTools, la classe STAC/STACResults (cartograpy.data), la classe Layout (planches multi-panneaux, cartograpy.mapper), et l’extension de WebMap (moteurs engine="folium"|"lonboard"|"kepler.gl", 13 méthodes supplémentaires dont add_cog() via rio-tiler). Documentés dans Reference VectorTools, Reference RasterTools, Reference data, Reference mapper et les guides correspondants.
  • click était déclaré dans les dépendances de pyproject.toml sans qu’aucune commande CLI n’existe dans le dépôt. Ajout de cartograpy/cli.py (init, fetch boundary/dem/osm/hydro/worldbank/climate/gee/stac, inspect, convert, map, doctor) et de l’entry point [project.scripts] cartograpy. Documenté dans Reference CLI.

Usage de cette page

Elle doit rester courte, factuelle et servir de point de suivi avant stabilisation de l’API.