From 3c60d9b19915cc26b72a9aa38d0259bd09e1632f Mon Sep 17 00:00:00 2001 From: Domizio Demichelis Date: Tue, 21 May 2019 09:41:51 +0700 Subject: [PATCH] minor doc fixes --- README.md | 1 + docs/api/countless.md | 2 +- docs/how-to.md | 4 ++-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5ca80e49d..f1c071679 100644 --- a/README.md +++ b/README.md @@ -148,6 +148,7 @@ Besides the classic pagination offered by the `pagy_nav` helpers, you can use a - [Pagination with Pagy](https://www.imaginarycloud.com/blog/paginating-ruby-on-rails-apps-with-pagy) by Tiago Franco - [Stateful Tabs with Pagy](https://www.imaginarycloud.com/blog/how-to-paginate-ruby-on-rails-apps-with-pagy) by Chris Seelus - [Quick guide for Pagy with Sinatra and Sequel](https://medium.com/@vfreefly/how-to-use-pagy-with-sequel-and-sinatra-157dfec1c417) by Victor Afanasev +- [Pagy with Templates Minipost](https://www.aloucaslabs.com/miniposts/how-to-install-pagy-gem-with-a-custom-pagination-template-on-a-ruby-on-rails-application) by aloucas - [Integrating Pagy with Hanami](http://katafrakt.me/2018/06/01/integrating-pagy-with-hanami/) by Paweł Świątkowski - [Detailed Gems Comparison](https://ddnexus.github.io/pagination-comparison/gems.html) (charts and analysis) - [Benchmarks and Memory Profiles Source](http://github.com/ddnexus/pagination-comparison) (Rails app repository) diff --git a/docs/api/countless.md b/docs/api/countless.md index 945ba239b..49a5afd7a 100644 --- a/docs/api/countless.md +++ b/docs/api/countless.md @@ -14,7 +14,7 @@ This class is providing support for extras that don't need the full set of pagin ## Caveats -In this class the `:count` variable is always `nil`, hence some feature that depends on it can have limited or no support: +In this class the `:count` variable is always `nil`, hence some feature that depends on it may have limited or no support: ### Features with limited support diff --git a/docs/how-to.md b/docs/how-to.md index 364085306..ccc3d3aa5 100644 --- a/docs/how-to.md +++ b/docs/how-to.md @@ -466,7 +466,7 @@ Here are some tips that will help chosing the best way to use Pagy, depending on If you need the classic pagination bar with links and info, then you have a couple of choices, depending on your environment: - If you are on ruby 2.0+, add the `oj` gem to your gemfile and use any `pagy*_nav_js` helper _(see [Javascript Navs](extras/navs.md#javascript-navs))_. That uses client side rendering and it is faster and lighter than using any `pagy*_nav` helper _(40x faster, 36x lighter and 1,410x more effcient than Kaminari)_. _Notice: the `oj` gem is not a requirement but helps the performance when it is available._ -- If you are on jruby (any version) or ruby 1.9+, or you cannot install `oj` then use the `pagy*_nav` helper, which will give you the same performance of pagy v2.0 (33x faster; 26x lighter; 850x more efficient than Kaminari) +- If you are on jruby (any version) or ruby 1.9.x, or you cannot install `oj` then use the `pagy*_nav` helper, which will give you the same performance of pagy v2.0 (33x faster; 26x lighter; 850x more efficient than Kaminari) ### Consider the combo navs @@ -489,7 +489,7 @@ Disallow: *__pagy_page__ **Caveats**: already indexed links may take a while to get purged by some search engine (i.e. you may still get some hits for a while even after you disallow them) -A quite drastical alternative to the `robot.txt` would be adding the following block to the `config/initializers/rack_attack.rb` (if you use the [Rack Attack Middlewhare](https://github.com/kickstarter/rack-attack)): +A quite drastic alternative to the `robot.txt` would be adding the following block to the `config/initializers/rack_attack.rb` (if you use the [Rack Attack Middlewhare](https://github.com/kickstarter/rack-attack)): ```ruby Rack::Attack.blocklist("block crawlers to follow pagy look-alike links") do |request|