Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document that files in pathlists are relative to the cwd, not to the pathlist location. #1414

Open
ctb opened this issue Mar 28, 2021 · 2 comments
Labels
doc documentation content or issues

Comments

@ctb
Copy link
Contributor

ctb commented Mar 28, 2021

currently, the file list returned by load_file_list_of_signatures is assumed to be relative to current working directory; an equally natural behavior would be to load relative paths based on the dirpath of the text file containing the file list.

whatever we decide, the behavior should be documented.

@ctb
Copy link
Contributor Author

ctb commented May 8, 2021

I'm pretty sure this should be relative to cwd, so as to avoid surprises. So this turns into a "make sure documentation reflects this behavior" issue.

@ctb ctb added the doc documentation content or issues label May 21, 2021
@ctb ctb changed the title should files in list-of-files be loaded from paths relative to the list? document that files in pathlists are relative to the cwd, not to the pathlist location. May 21, 2021
@ctb
Copy link
Contributor Author

ctb commented Aug 3, 2022

it's, uh, interesting to note that we don't actually document pathlists at all anywhere? We refer to --from-file and --query-from-file but not pathlists:

Passing in lists of files

Most sourmash commands will also take a --from-file or --query-from-file, which will take the location of a text file containing a list of file paths. This can be useful for situations where you want to specify thousands of queries, or a subset of signatures produced by some other command.

I wonder if we should consider removing pathlist support altogether? I like the explicit nature of --query-from-file and --from-file, and standalone manifests are better for the other pathlist use cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc documentation content or issues
Projects
None yet
Development

No branches or pull requests

1 participant