Developer Guide: Document practices for data files#37399

Merged

vbraun merged 13 commits intosagemath:developfrom

mkoeppe:document_package_data_practices

Mar 31, 2024

Commits on Mar 26, 2024

src/doc/en/developer/coding_basics.rst: Large data files should not be added to the Sage source tree
mkoeppe
committed
Add compression suggestion and guiding example repos (#26)

gmou3
authored and
Matthias Köppe
committed
src/doc/en/developer/coding_basics.rst: Add links to packaging instructions
mkoeppe
committed
src/doc/en/developer/coding_basics.rst: Mention importlib.resources.files
mkoeppe
committed
src/doc/en/developer/coding_basics.rst: Show how to import importlib.resources.files
mkoeppe
committed
src/doc/en/developer/coding_basics.rst: Mention importlib.resources.as_file, add links to tutorial
mkoeppe
committed
src/doc/en/developer/coding_basics.rst: Add importlib.resources examples

tornaria
authored and
Matthias Köppe
committed
src/doc/en/developer/coding_basics.rst: Use sys.version_info instead of try..except
mkoeppe
committed
src/doc/en/developer/coding_basics.rst: Details on resource `open` examples

mkoeppe
and
tornaria
committed
src/doc/en/developer/coding_basics.rst: Don't encourage PRs that update direct access to data files using __file__ for now
mkoeppe
committed
src/doc/en/developer/coding_basics.rst: Link to https://github.com/sagemath/sage/issues/33037 for SAGE_EXTCODE deprecation
mkoeppe
committed
src/doc/en/developer/coding_basics.rst: Remove advice on how to import from importlib.resources, fix markup
mkoeppe
committed
src/doc/en/developer/coding_basics.rst: Fix markup, break long lines
mkoeppe
committed