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 pagers most and more are not used #1666

Closed
pgimalac opened this issue May 28, 2021 · 4 comments
Closed

Document that pagers most and more are not used #1666

pgimalac opened this issue May 28, 2021 · 4 comments
Labels
documentation help wanted Extra attention is needed

Comments

@pgimalac
Copy link

pgimalac commented May 28, 2021

As mentioned in #1063, pagers most and more are not used by bat for compatibility reasons, silently falling back to less (when set with PAGER environment variable), but this is not documented anywhere but the release description https://github.com/sharkdp/bat/releases/tag/v0.18.0.

I believe it should at least be explained why in the README.

@Enselic
Copy link
Collaborator

Enselic commented Jun 6, 2021

@pgimalac thanks for taking the time to report.

Is https://github.com/sharkdp/bat/blob/f366bbe34941f1c94851b4a91eef90b2dc3bc3ba/README.md#using-a-different-pager good enough from your perspective? If not, what would you change?

@pgimalac
Copy link
Author

pgimalac commented Jun 6, 2021

@Enselic thanks to you for taking the time to document this :)

I let you judge but perhaps referencing the issue which led to this choice (#1063) so people can easily find the details ? Otherwise I think it is good enough !

@Enselic
Copy link
Collaborator

Enselic commented Jun 8, 2021

Thanks for the feedback!

I do think however that the README.md would become too noisy if we would start adding references, so let's keep it as is. It is easy enough to dig deeper for those that want, using git grep, git blame, etc.

@Enselic Enselic closed this as completed in c8dd328 Jun 8, 2021
@pgimalac
Copy link
Author

pgimalac commented Jun 8, 2021

@Enselic that's exactly what I was worried about, and why I said that I let you judge.
Thanks for taking the time to document this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants