Skip to content

Commit 732c896

Browse files
committed
doc tweaks
1 parent ad5d937 commit 732c896

File tree

4 files changed

+6
-2
lines changed

4 files changed

+6
-2
lines changed

django_typer/completers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ class ModelObjectCompleter:
7676
- `ImageField <https://docs.djangoproject.com/en/stable/ref/models/fields/#imagefield>`_
7777
- `FilePathField <https://docs.djangoproject.com/en/stable/ref/models/fields/#filepathfield>`_
7878
- `TextField <https://docs.djangoproject.com/en/stable/ref/models/fields/#textfield>`_
79-
- `DateField <https://docs.djangoproject.com/en/stable/ref/models/fields/#datefield>`_ **(Must use ISO 8601 format (YYYY-MM-DD)**
79+
- `DateField <https://docs.djangoproject.com/en/stable/ref/models/fields/#datefield>`_ **(Must use ISO 8601: YYYY-MM-DD)**
8080
- `UUIDField <https://docs.djangoproject.com/en/stable/ref/models/fields/#uuidfield>`_
8181
- `FloatField <https://docs.djangoproject.com/en/stable/ref/models/fields/#floatfield>`_
8282
- `DecimalField <https://docs.djangoproject.com/en/stable/ref/models/fields/#decimalfield>`_

django_typer/management/commands/shellcompletion.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ def uninstall(
388388
Since the installation routine is upstream we first run install to determine where the
389389
completion script is installed and then we remove it.
390390
391-
.. typer:: django_typer.management.commands.shellcompletion.Command:typer_app:remove
391+
.. typer:: django_typer.management.commands.shellcompletion.Command:typer_app:uninstall
392392
:prog: shellcompletion
393393
:width: 80
394394
:convert-png: latex

doc/source/changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ v3.0.0 (202X-XX-XX)
2626
* Fixed `Installed shellcompletion scripts do not pass values of --settings or --pythonpath <https://github.com/django-commons/django-typer/issues/68>`_
2727
* Fixed `shellcompletion complete should print to the command's stdout. <https://github.com/django-commons/django-typer/issues/19>`_
2828
* Implemented `Add completer/parser for FileField and FilePathField <https://github.com/django-commons/django-typer/issues/17>`_
29+
* Implemented `Add completer/parser for DateTimeField <https://github.com/django-commons/django-typer/issues/15>`_
2930
* Implemented `Add completer/parser for DateField <https://github.com/django-commons/django-typer/issues/14>`_
3031

3132

doc/source/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,9 @@
9494
r'https://github.com/django/django/blob/main/django/core/management/__init__.py#L278', # Ignore exact match
9595
]
9696

97+
autodoc_typehints = "description" # or signature
98+
autodoc_typehints_format = "short"
99+
97100
def setup(app):
98101
# Register a sphinx.ext.autodoc.between listener to ignore everything
99102
# between lines that contain the word IGNORE

0 commit comments

Comments
 (0)