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

resolve_binary name is misleading #2928

Open
dandavison opened this issue Nov 10, 2024 · 0 comments
Open

resolve_binary name is misleading #2928

dandavison opened this issue Nov 10, 2024 · 0 comments

Comments

@dandavison
Copy link

dandavison commented Nov 10, 2024

Hi, thanks again for ripgrep! In delta we're using resolve_binary, and I have a question / feature request regarding its API (which I'm opening as a feature request issue). The second sentence of the docstring says "If the program could not be resolved, then an error is returned.", whereas in fact this is only true on Windows, as the last sentence says. This has caused me and others to make mistakes. My question is

  • Would a name like resolve_windows_binary have been a clearer name, or was there a reason not to do that?

And my feature request

  • Assuming a breaking renaming change is not reasonable, how about moving the final sentence of the docstring ("On non-Windows, this is a no-op.") up so that it becomes part of the first sentence of the docstring?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant