-
Notifications
You must be signed in to change notification settings - Fork 6
Update limitations for 5.1.0b3 release #32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for docs-django ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Please approve the deploy request and confirm whether or not the intersphinx links work. I'm not sure exactly where we are on that (#28). The syntax is copied from the django-mongodb-backend docs, but it seems there may still be some incompatibilities (bugs?) with the MongoDB documentation builder. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some comments!
source/limitations-upcoming.txt
Outdated
Database caching uses this {+django-odm+}'s ``createcachecollection`` command | ||
rather Django's SQL-specific ``createcachetable``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: some small wording suggestions:
Database caching uses this {+django-odm+}'s ``createcachecollection`` command | |
rather Django's SQL-specific ``createcachetable``. | |
Database caching uses {+django-odm+}'s ``createcachecollection`` command | |
rather than {+framework+}'s SQL-specific ``createcachetable`` command. |
source/limitations-upcoming.txt
Outdated
rather Django's SQL-specific ``createcachetable``. | ||
|
||
Secondly, you must use the ``django_mongodb_backend.cache.MongoDBCache`` | ||
backend rather than Django's built-in database cache backend, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S:
backend rather than Django's built-in database cache backend, | |
backend rather than {+framework+}'s built-in database cache backend, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Uff, using a 13 character macro instead of "Django" seems tedious! Why not a macro for "MongoDB"? ;-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed it seems a little unnecessary but we try to use the macros as much as possible for product names
source/limitations-upcoming.txt
Outdated
:class:`~django.db.models.functions.TruncDate` and | ||
:class:`~django.db.models.functions.TruncTime` database functions isn't |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I: these links aren't working; can you try using the :py:func:
role instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i.e. :py:func:~django.db.models.functions.TruncDate
and :py:func:~django.db.models.functions.TruncTime
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are classes, not functions. I guess the py prefix is required though.
@@ -181,7 +182,7 @@ Unsupported Management Commands | |||
|
|||
The following ``django-admin`` commands are unsupported: | |||
|
|||
- ``createcachetable`` | |||
- ``createcachetable`` (see :ref:`django-limitations-caching`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at the rendered docs, there appears to be a docs platform bug where the closing parenthesis is included in the link. Could you report it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
interesting, I will let the platform team know. You might be able to get around it if you use :ref:Caching <django-limitations-caching>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it matters enough to try a workaround. I'll trust the bug will be fixed soon enough. Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Staging Links