From a0c451d930212a463e63511dc0512d2d06fe4335 Mon Sep 17 00:00:00 2001 From: Bogdan Gusiev Date: Sun, 10 Nov 2024 21:57:21 +0100 Subject: [PATCH] Update doc --- Readme.markdown | 10 ++++++---- lib/datagrid/form_builder.rb | 5 +---- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/Readme.markdown b/Readme.markdown index 98a9f80..924fa4c 100644 --- a/Readme.markdown +++ b/Readme.markdown @@ -1,11 +1,13 @@ # Datagrid -[![Build Status](https://github.com/bogdan/datagrid/workflows/CI/badge.svg?branch=master)](https://github.com/bogdan/datagrid/actions) +Datagrid Version 2.0.0 is here. + +[Migration Guide](./version-2). -[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid?ref=badge_shield) +[![Build Status](https://github.com/bogdan/datagrid/workflows/CI/badge.svg?branch=master)](https://github.com/bogdan/datagrid/actions) A really mighty and flexible ruby library that generates reports -including admin panels, analytics and data representation: +including admin panels, analytics and data browsers: * Filtering * Columns @@ -31,7 +33,7 @@ including admin panels, analytics and data representation: ## Documentation -* [Readme](/Readme.markdown) - this read-me for basic information. +* Readme - this read-me for basic information. * [Wiki](https://github.com/bogdan/datagrid/wiki) - general reference on how to use the gem. * [Rdoc](https://rubydoc.info/gems/datagrid) - API reference. diff --git a/lib/datagrid/form_builder.rb b/lib/datagrid/form_builder.rb index a53b79a..aec1cc0 100644 --- a/lib/datagrid/form_builder.rb +++ b/lib/datagrid/form_builder.rb @@ -6,10 +6,7 @@ module Datagrid module FormBuilder # @param filter_or_attribute [Datagrid::Filters::BaseFilter, String, Symbol] filter object or filter name # @param options [Hash] options of rails form input helper - # @return [String] a form input html for the corresponding filter name - # * select for enum, xboolean filter types - # * check_box for boolean filter type - # * text_field for other filter types + # @return [String] a form input html for the corresponding filter def datagrid_filter(filter_or_attribute, **options, &block) filter = datagrid_get_filter(filter_or_attribute) send(filter.form_builder_helper_name, filter, **options, &block)