juehang / numerax / 18617565886

100%

push

github

docs(utils): improve preserve_metadata docs and add comprehensive tests

- Generalize preserve_metadata documentation to be less JAX-specific
- Expand overview to explain metadata preservation problem more clearly
- Replace JAX-focused example with general decorator example showing
  the contrast between decorated functions with/without preserve_metadata
- Add test_preserve_metadata_with_custom_jvp to verify JAX compatibility
- Add test_preserve_metadata_with_simple_decorator to demonstrate
  metadata preservation vs loss with a basic decorator

The enhanced documentation better explains why this utility exists and
how it solves the metadata preservation problem. Tests ensure the
function works correctly with both JAX decorators and simple Python
decorators.

21 of 21 branches covered (100.0%)

Branch coverage included in aggregate %.

35 of 35 new or added lines in 1 file covered. (100.0%)

476 of 478 relevant lines covered (99.58%)

1.0 hits per line