docs: small link fixes, corrections

hodossy · Dec 23, 2020 · 8ab4b83 · 8ab4b83
1 parent 1414f1d
commit 8ab4b83
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ Install using `pip`,
 pip install django-nlf
 ```
 
-And add :code:`django_nlf` to your :code:`INSTALLED_APPS`.
+And add `django_nlf` to your `INSTALLED_APPS`.
 
 ```
 INSTALLED_APPS = [
@@ -34,12 +34,12 @@ from .models import Article
 
 nl_filter = DjangoNLFilter()
 qs = Article.objects.all()
-q = 'author.username is john or title contains news'
+q = "author.username is john or title contains news"
 # equivalent to Article.objects.filter(Q(author__username="user") | Q(title__icontains="news"))
 articles = nl_filter.filter(qs, q)
 
 # Nested logical operators are also supported:
-q = 'author.username is john and (title contains news or created_at <= 2020-06-05)'
+q = "author.username is john and (title contains news or created_at <= 2020-06-05)"
 # equivalent to
 # Article.objects.filter(
 #   Q(author__username="user") & (Q(title__icontains="news") | Q(created_at__lte="2020-06-05"))
@@ -51,11 +51,11 @@ articles = nl_filter.filter(qs, q)
 
 You just need to simply add the natural language filter backend to your filter backends list.
 
-```
+```python
 REST_FRAMEWORK = {
-  'DEFAULT_FILTER_BACKENDS': (
+  "DEFAULT_FILTER_BACKENDS": (
     ...
-    'django_nlf.rest_framework.DjangoNLFilterBackend',
+    "django_nlf.rest_framework.DjangoNLFilterBackend",
   ),
 }
 ```
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -57,7 +57,3 @@ NLF_QUERY_PARAM
 Default: ``"q"``
 
 This applies to the Django RESTFramework Backend. This parameter is used for extracting the filter expression from the ``GET`` query parameters.
-
-
-  "PATH_SEPARATOR": ".",
-  "QUERY_PARAM": "q",
diff --git a/docs/customizations/field_name_conversion.rst b/docs/customizations/field_name_conversion.rst
@@ -1,6 +1,17 @@
 Converting field names
 ======================
 
+You may not like the snake case convention widely used in Python to be used in the filtering expressions your user write. Therefore you can use one of the built in case coverters or write your own.
+
+Built in converters
+*******************
+
+.. autofunction:: django_nlf.utils.camel_to_snake_case
+
+
+Custom converter
+****************
+
 To support automatic case conversion, a custom implementation can be provided.
 
 .. code-block:: python

diff --git a/docs/customizations/index.rst b/docs/customizations/index.rst
@@ -4,5 +4,5 @@ Customization
 .. toctree::
    :maxdepth: 1
 
-   custom_functions.rst
    field_name_conversion.rst
+   custom_functions.rst
diff --git a/docs/development/index.rst b/docs/development/index.rst
@@ -25,8 +25,8 @@ All development dependencies are listed in :code:`dev_requirements.txt`.
 
 A :code:`Makefile` is available with the most common operations that are need to be run. The following targets are available:
 
-- :code:`make lint`: Runs [black](https://black.readthedocs.io/en/stable/) in check mode and [pylint](http://pylint.pycqa.org/)
-- :code:`make format`: Runs [black](https://black.readthedocs.io/en/stable/) and formats each file
+- :code:`make lint`: Runs `black <https://black.readthedocs.io/en/stable/>`_ in check mode and `pylint <http://pylint.pycqa.org/>`_
+- :code:`make format`: Runs `black <https://black.readthedocs.io/en/stable/>`_ and formats each file
 - :code:`make test`: Runs the test suite
 - :code:`make coverage`: Runs the test suite and measures coverage
 - :code:`make docs`: Builds the documentation

diff --git a/docs/language/lookups.rst b/docs/language/lookups.rst
@@ -5,10 +5,6 @@ Supported Lookups
 
     The lookups are all case insensitive.
 
-  .. note::
-
-    Custom lookups are not supported currently.
-
 Equals
 ******
 
@@ -38,3 +34,7 @@ Lower than (or equal)
 ***********************
 
 Can be expressed as :code:`<` and :code:`<=`, and means a comparison against the given value.
+
+  .. note::
+
+    Custom lookups are not supported currently.
diff --git a/docs/language/operators.rst b/docs/language/operators.rst
@@ -18,7 +18,7 @@ Can be expressed as :code:`or`.
 Not
 ***
 
-Can be expressed as :code:`not` in front of *functions*, *expressions* or group of *expressions*.
+Can be expressed as :code:`not` in front of *functions* and group of *expressions*. *Expressions* can be negated by negating the *lookup* (e.g. :code:`is` -> :code:`is not`).
 
 Groups
 ******