StarFields/starfields-drf-generics
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 6 Wiki Activity

Fixed some capitalization in README.md

Browse Source
This commit is contained in:
Pelagic
2024-04-12 10:47:45 +03:00
parent 84eeea05fc
commit 3662427fdf
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -59,16 +59,16 @@ class SearchView(generics.CachedListRetrieveAPIView):
### New class attributes that are used
| Attribute | Description |
| --------- | ----------- |
| cache_prefix | defines the prefix that the module will use when saving values in the cache |
| cache_vary_on_user | defines whether keys saved in the cache are different for each user, in which case extra user information will be added to the cache prefix |
| cache_timeout_mins | the cache key timeout |
| filter_backends | the filters that you want the view to have, each can be configured with view class attributes |
| ordering_fields | if you use the OrderingFilter you must indicate what fields the user can order by, the first element is used as the default order |
| search_fields | if you use the TrigramSearchFilter you must indicate the fields to search through |
| paged | your generic view can have a pager for the user to choose pages or it can be a full listing |
| default_page_size | the default size of the pages if a user has not indicated a page size |
| logger | you should register a logger in order to get error feedback in your deployments |
| cache | the main feature of this module is automated and organized caching, you should register your cache here |
| cache_prefix | Defines the prefix that the module will use when saving values in the cache |
| cache_vary_on_user | Defines whether keys saved in the cache are different for each user, in which case extra user information will be added to the cache prefix |
| cache_timeout_mins | The cache key timeout |
| filter_backends | The filters that you want the view to have, each can be configured with view class attributes |
| ordering_fields | If you use the OrderingFilter you must indicate what fields the user can order by, the first element is used as the default order |
| search_fields | If you use the TrigramSearchFilter you must indicate the fields to search through |
| paged | Your generic view can have a pager for the user to choose pages or it can be a full listing |
| default_page_size | The default size of the pages if a user has not indicated a page size |
| logger | You should register a logger in order to get error feedback in your deployments |
| cache | The main feature of this module is automated and organized caching, you should register your cache here |
### Extras