Skip to content
New issue

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

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

Already on GitHub? # to your account

Skip update when page not found #364

Merged
merged 11 commits into from
Nov 2, 2021
Merged

Skip update when page not found #364

merged 11 commits into from
Nov 2, 2021

Conversation

MDecker-MobileComputing
Copy link
Contributor

Description

Introduced new configuration variable skipUpdateWhenPageNotFound for config.json or .tldrrc. When this variable is set to true, then upon a cache miss no (lengthy) cache update will be performed (on slower machines like a Raspberry Pi this update can take more than four minutes).

Checklist

Please review this checklist before submitting a pull request.

  • Code compiles correctly
  • Created tests, if possible
  • All tests passing (npm run test:all)
  • Extended the README / documentation, if necessary

Co-authored-by: marchersimon <50295997+marchersimon@users.noreply.github.com>
…eComputing/tldr-node-client into skipUpdateWhenPageNotFound
Copy link
Contributor

@marchersimon marchersimon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@MasterOdin MasterOdin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

slight tweaks on wording, otherwise looks fine.

Co-authored-by: Matthew Peveler <matt.peveler@gmail.com>
Co-authored-by: Matthew Peveler <matt.peveler@gmail.com>
@marchersimon
Copy link
Contributor

@MasterOdin @owenvoke can we merge this?

@owenvoke
Copy link
Member

owenvoke commented Nov 2, 2021

@marchersimon, I think so. I just left it as I don't really maintain the Node client.

@agnivade
Copy link
Member

agnivade commented Nov 2, 2021

I think I was against this feature in the first place 😛 But now that it's there, we have obviously landed with a config knob to disable this.

Thanks for the reviews everyone.

@agnivade agnivade merged commit be87030 into tldr-pages:master Nov 2, 2021
@MDecker-MobileComputing MDecker-MobileComputing deleted the skipUpdateWhenPageNotFound branch November 2, 2021 15:31
@MDecker-MobileComputing
Copy link
Contributor Author

When will a new version of tldr-node-client (which contains the change of this PR) be published on npmjs.com?

@agnivade
Copy link
Member

agnivade commented Nov 3, 2021

I will have to publish it. But if you want to have it urgently, you can fetch from master by passing the git commit.

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants