doc tweaks

django-commons · Jan 17, 2025 · 732c896 · 732c896
1 parent ad5d937
commit 732c896
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/django_typer/completers.py b/django_typer/completers.py
@@ -76,7 +76,7 @@ class ModelObjectCompleter:
             - `ImageField <https://docs.djangoproject.com/en/stable/ref/models/fields/#imagefield>`_
         - `FilePathField <https://docs.djangoproject.com/en/stable/ref/models/fields/#filepathfield>`_
         - `TextField <https://docs.djangoproject.com/en/stable/ref/models/fields/#textfield>`_
-        - `DateField <https://docs.djangoproject.com/en/stable/ref/models/fields/#datefield>`_ **(Must use ISO 8601 format (YYYY-MM-DD)**
+        - `DateField <https://docs.djangoproject.com/en/stable/ref/models/fields/#datefield>`_ **(Must use ISO 8601: YYYY-MM-DD)**
         - `UUIDField <https://docs.djangoproject.com/en/stable/ref/models/fields/#uuidfield>`_
         - `FloatField <https://docs.djangoproject.com/en/stable/ref/models/fields/#floatfield>`_
         - `DecimalField <https://docs.djangoproject.com/en/stable/ref/models/fields/#decimalfield>`_

diff --git a/django_typer/management/commands/shellcompletion.py b/django_typer/management/commands/shellcompletion.py
@@ -388,7 +388,7 @@ def uninstall(
         Since the installation routine is upstream we first run install to determine where the
         completion script is installed and then we remove it.
 
-        .. typer:: django_typer.management.commands.shellcompletion.Command:typer_app:remove
+        .. typer:: django_typer.management.commands.shellcompletion.Command:typer_app:uninstall
             :prog: shellcompletion
             :width: 80
             :convert-png: latex

diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst
@@ -26,6 +26,7 @@ v3.0.0 (202X-XX-XX)
 * Fixed `Installed shellcompletion scripts do not pass values of --settings or --pythonpath <https://github.com/django-commons/django-typer/issues/68>`_
 * Fixed `shellcompletion complete should print to the command's stdout. <https://github.com/django-commons/django-typer/issues/19>`_
 * Implemented `Add completer/parser for FileField and FilePathField <https://github.com/django-commons/django-typer/issues/17>`_
+* Implemented `Add completer/parser for DateTimeField <https://github.com/django-commons/django-typer/issues/15>`_
 * Implemented `Add completer/parser for DateField <https://github.com/django-commons/django-typer/issues/14>`_
 
 

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -94,6 +94,9 @@
     r'https://github.com/django/django/blob/main/django/core/management/__init__.py#L278',  # Ignore exact match
 ]
 
+autodoc_typehints = "description"  # or signature
+autodoc_typehints_format = "short"
+
 def setup(app):
     # Register a sphinx.ext.autodoc.between listener to ignore everything
     # between lines that contain the word IGNORE