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

Add note about auto-updates when cache is missing #254

Merged
merged 1 commit into from
Feb 6, 2022

Conversation

dbrgn
Copy link
Collaborator

@dbrgn dbrgn commented Jan 9, 2022

Output:

screenshot-20220109-153929

Fixes #250.

@niklasmohrin @uhthomas what do you think?

@dbrgn dbrgn added the docs label Jan 9, 2022
@dbrgn dbrgn self-assigned this Jan 9, 2022
@niklasmohrin
Copy link
Collaborator

To be honest, I think it is a bit verbose and might be more intimidating than helpful for first-time users. How do you fell about:

Error: Cache not found. Please run `tldr --update` to download the cache.

Your first time using tealdeer? You can find some tips and tricks to get started at
    https://dbrgn.github.io/tealdeer/getting_started.html

... and then we put the text you have here in a subsection of configuration (or it already exists, I don't know). In the getting-started page, we could put some links and maybe some config recommendations for ease of use (like auto-update). What do you think?

(I also changed the "Warning" to "Error", because this is an error; I think we should change this on main :D)

@dbrgn
Copy link
Collaborator Author

dbrgn commented Feb 5, 2022

I thought about it again, and I'd stick to the current version of the PR (with slight rewording). The message will only be shown when a cache is missing, meaning that tealdeer wasn't yet initialized on that system (so usually just once). In this case, it's good if the information is right there, without having to open the webbrowser and visit a website first. (I think I wouldn't do that myself, I'd just copy-paste the command and miss the bit about auto updates.)

Here's an updated version:

screenshot-20220205-012018

@niklasmohrin can you live with that? 🙂

@dbrgn
Copy link
Collaborator Author

dbrgn commented Feb 5, 2022

Ah, and I changed the warning to an error.

@niklasmohrin
Copy link
Collaborator

Code looks good; I personally still think that the note is a bit long and the error is a bit lost in all of the text, but that may just be me (one other person I asked said it's clear to them)

@dbrgn dbrgn merged commit 5a1a21b into main Feb 6, 2022
@dbrgn dbrgn deleted the cache-auto-update-note branch February 6, 2022 21:53
niklasmohrin added a commit to niklasmohrin/tealdeer that referenced this pull request Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

Auto update cache by default?
2 participants