Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Commit

Permalink
docs(settings): Update Constant names #59
Browse files Browse the repository at this point in the history
Updating constant names getting ready for the addition of new
constants will keep the naming consistent.

closes #59
  • Loading branch information
imAsparky committed May 6, 2023
1 parent 75b2c94 commit 1395043
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ of renaming.
enhanced unicode-compatible slug.

If you wish to maintain the old stripping behavior, set the setting
`TAGGIT_STRIP_UNICODE_WHEN_SLUGIFYING` to `True`.
`TAGS_STRIP_UNICODE_WHEN_SLUGIFYING` to `True`.

As a reminder, custom tag models can easily customize slugification behavior by overriding
the `slugify` method to your business needs.
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ of renaming.
enhanced unicode-compatible slug.

If you wish to maintain the old stripping behavior, set the setting
``TAGGIT_STRIP_UNICODE_WHEN_SLUGIFYING`` to ``True``.
``TAGS_STRIP_UNICODE_WHEN_SLUGIFYING`` to ``True``.

As a reminder, custom tag models can easily customize slugification behavior by overriding
the ``slugify`` method to your business needs.
Expand Down
8 changes: 4 additions & 4 deletions docs/custom_tagging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -224,14 +224,14 @@ below.
To use a specific function instead of the string parser, add a new setting
called "TAGGIT_TAGS_FROM_STRING" and provide its dotted path to your desired
called "TAGS_GET_TAGS_FROM_STRING" and provide its dotted path to your desired
function.


You can also offer a function that transforms a collection of tags into a
string format. To change the default value
(which is "tag_fields.utils._edit_string_for_tags"), use the
"TAGGIT_STRING_FROM_TAGS" setting.
"TAGS_GET_STRING_FROM_TAGS" setting.

.. code-block:: python
Expand All @@ -243,5 +243,5 @@ project's settings.py file should include the following.

.. code-block:: python
TAGGIT_TAGS_FROM_STRING = 'appname.utils.comma_splitter'
TAGGIT_STRING_FROM_TAGS = 'appname.utils.comma_joiner'
TAGS_GET_TAGS_FROM_STRING = 'appname.utils.comma_splitter'
TAGS_GET_STRING_FROM_TAGS = 'appname.utils.comma_joiner'
10 changes: 5 additions & 5 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ And then, to any model you want tagged, do the following.
.. tip::

To make ``django-tag-fields`` search for existing tags in a
case-insensitive way, you need to modify the ``TAGGIT_CASE_INSENSITIVE``
case-insensitive way, you need to modify the ``TAGS_CASE_INSENSITIVE``
setting.

By default, it is set to ``False``, but you can change it to ``True`` in
your Django settings file or wherever you store your settings.

.. code-block:: python
TAGGIT_CASE_INSENSITIVE = True
TAGS_CASE_INSENSITIVE = True
Settings
Expand All @@ -53,7 +53,7 @@ settings below.
.. code-block:: python
TAGGIT_CASE_INSENSITIVE
TAGS_CASE_INSENSITIVE
""""
Defaults to ``False``. When set to ``True``, tag lookups will be case
Expand All @@ -62,7 +62,7 @@ settings below.
.. code-block:: python
TAGGIT_STRIP_UNICODE_WHEN_SLUGIFYING
TAGS_STRIP_UNICODE_WHEN_SLUGIFYING
""""
Defaults to False. When set to True, tag slugs will be limited to ASCII
Expand All @@ -78,6 +78,6 @@ settings below.
.. caution::

The behaviour of ``TAGGIT_STRIP_UNICODE_WHEN_SLUGIFYING`` , when ``True``,
The behaviour of ``TAGS_STRIP_UNICODE_WHEN_SLUGIFYING`` , when ``True``,
leads to situations where slugs can be entirely stripped to an empty string;
we **dont** recommend activating this.

0 comments on commit 1395043

Please sign in to comment.