Skip to content

Commit 0ac75c0

Browse files
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 standard
1 parent 65a8b6c commit 0ac75c0

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

src/vcspull/config.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,21 @@ def is_valid_config_dict(val: t.Any) -> t.TypeGuard[ConfigDict]:
349349
def find_home_config_files(
350350
filetype: list[str] | None = None,
351351
) -> list[pathlib.Path]:
352-
"""Return configs of ``.vcspull.{yaml,json}`` in user's home directory."""
352+
"""Return configs of ``.vcspull.{yaml,json}`` in user's home directory.
353+
354+
Paths are resolved through symlinks so callers receive the real
355+
filesystem location, consistent with the ``-f`` flag codepath.
356+
357+
Parameters
358+
----------
359+
filetype : list of str, optional
360+
File types to search for (default ``["json", "yaml"]``)
361+
362+
Returns
363+
-------
364+
list of pathlib.Path
365+
Resolved paths to discovered config files
366+
"""
353367
if filetype is None:
354368
filetype = ["json", "yaml"]
355369
configs: list[pathlib.Path] = []

0 commit comments

Comments
 (0)