Skip to content

Commit

Permalink
QA modifications and TODO
Browse files Browse the repository at this point in the history
  • Loading branch information
marianoeramirez committed Jan 8, 2024
1 parent bb51fdb commit dfbbb2b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
7 changes: 7 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,13 @@ If you want to build the docs, use the following steps::
cd docs
make html

TODOS
-----

- Add ruff for formatting
- Improve the performance of the import command
- Improve the local development environment with https://tox.wiki/en/legacy/example/devenv.html

Resources
---------

Expand Down
11 changes: 6 additions & 5 deletions src/cities_light/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,16 @@
.. py:data:: INDEX_SEARCH_NAMES
If your database engine for cities_light supports indexing TextFields,
If your database engine for cities_light supports indexing TextFields,
then this should be set to True. You might have to
override this setting with ``settings.CITIES_LIGHT_INDEX_SEARCH_NAMES`` if
using several databases for your project.
Notes:
Notes:
- MySQL doesn't support indexing TextFields.
- PostgreSQL supports indexing TextFields, but it is not enabled by default
in cities_light because the lenght of the field can be too long for btree,
for more infomration please visit #273
in cities_light because the lenght of the field can be too long for btree
for more information please visit #273
.. py:data:: CITIES_LIGHT_APP_NAME
Expand Down Expand Up @@ -154,7 +154,8 @@
if INDEX_SEARCH_NAMES is None:
INDEX_SEARCH_NAMES = True
for database in list(settings.DATABASES.values()):
if "ENGINE" in database and ('mysql' in database.get('ENGINE').lower() or 'postgresql' in database.get('ENGINE').lower()):
if "ENGINE" in database and ('mysql' in database.get('ENGINE').lower()
or 'postgresql' in database.get('ENGINE').lower()):
INDEX_SEARCH_NAMES = False

DEFAULT_APP_NAME = 'cities_light'
Expand Down

0 comments on commit dfbbb2b

Please sign in to comment.