Commit 0ac75c0
committed
docs(config[find_home_config_files]) document symlink resolution and add param/return sections
why: Docstring did not reflect the behavioral change from adding
`.resolve()`, and was missing NumPy-style parameter/return sections.
what:
- Note that returned paths are resolved through symlinks
- Add Parameters and Returns sections per NumPy docstring standard1 parent 65a8b6c commit 0ac75c0
1 file changed
Lines changed: 15 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
349 | 349 | | |
350 | 350 | | |
351 | 351 | | |
352 | | - | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
353 | 367 | | |
354 | 368 | | |
355 | 369 | | |
| |||
0 commit comments