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

In eq_file docs, mention utf8? #145

Open
smoelius opened this issue May 23, 2023 · 3 comments
Open

In eq_file docs, mention utf8? #145

smoelius opened this issue May 23, 2023 · 3 comments

Comments

@smoelius
Copy link
Contributor

Should the eq_file docs mention utf8?

With the code that is there now, a mismatch results in a somewhat opaque list of byte values. While it is not too hard to find utf8, mentioning it outright would save the extra step.

I can send a PR if you agree.

@epage
Copy link
Contributor

epage commented May 23, 2023

I feel like the ideal solution would be to move eq_file onto BinaryFilePredicate and have a use re-export it as this would point people to the type and the docs would all be in one place but that doesn't appear to be supported in Rust.

If moving forward with this, I'd prefer that all of the other cases get a similar treatment.

@smoelius
Copy link
Contributor Author

If moving forward with this, I'd prefer that all of the other cases get a similar treatment.

"Other cases"?

@epage
Copy link
Contributor

epage commented May 23, 2023

The big issue here is discoverability of methods on the returned predicated. We have other predicate types with methods that we should be calling out

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

2 participants