Commit 2a59175
committed
docs(config[save_config_yaml_with_items]) add NumPy docstring with doctest
why: Function had only a one-line summary with no Parameters, Returns, or
Examples section despite the project requiring full NumPy docstrings and
working doctests on all public functions.
what:
- Add description explaining why this differs from save_config_yaml (preserves
duplicate top-level keys via ordered pairs)
- Add Parameters and Returns sections per NumPy docstring standard
- Add Examples section with duplicate-section round-trip doctest1 parent a81abb0 commit 2a59175
1 file changed
Lines changed: 28 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
882 | 882 | | |
883 | 883 | | |
884 | 884 | | |
885 | | - | |
| 885 | + | |
| 886 | + | |
| 887 | + | |
| 888 | + | |
| 889 | + | |
| 890 | + | |
| 891 | + | |
| 892 | + | |
| 893 | + | |
| 894 | + | |
| 895 | + | |
| 896 | + | |
| 897 | + | |
| 898 | + | |
| 899 | + | |
| 900 | + | |
| 901 | + | |
| 902 | + | |
| 903 | + | |
| 904 | + | |
| 905 | + | |
| 906 | + | |
| 907 | + | |
| 908 | + | |
| 909 | + | |
| 910 | + | |
| 911 | + | |
| 912 | + | |
886 | 913 | | |
887 | 914 | | |
888 | 915 | | |
| |||
0 commit comments