[Django] #35824: Improve patch_cache_control documentation

[Django]

#35824: Improve patch_cache_control documentation
-------------------------------------+-------------------------------------
Reporter: Adam Johnson | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: dev | Severity: Normal
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
[https://docs.djangoproject.com/en/dev/ref/utils/#django.utils.cache.patch_cache_control
The documentation] for this response modifier lists rules, but only rules.
It would be a lot clearer with a table of transformed names for common
parameters and a usage example.
--
Ticket URL: <https://code.djangoproject.com/ticket/35824>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#35824: Improve patch_cache_control documentation
--------------------------------------+------------------------------------
Reporter: Adam Johnson | Owner: (none)

Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by Sarah Boyce):

* stage: Unreviewed => Accepted

Comment:

Agreed - I think that would be a nice improvement
--
Ticket URL: <https://code.djangoproject.com/ticket/35824#comment:1>

[Django]

#35824: Improve patch_cache_control documentation
-------------------------------------+-------------------------------------

Reporter: Adam Johnson | Owner: Waqas
Type: | Younas
Cleanup/optimization | Status: assigned

Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Waqas Younas):

* owner: (none) => Waqas Younas
* status: new => assigned

Comment:

Hello, I'm new to Django and I'd like to solve this so I've assigned this
to myself as my first ticket :).

Next step for me: figure out where that change needs to be made in the
docs.
--
Ticket URL: <https://code.djangoproject.com/ticket/35824#comment:2>

[Django]

#35824: Improve patch_cache_control documentation
-------------------------------------+-------------------------------------
Reporter: Adam Johnson | Owner: Waqas
Type: | Younas
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Ahmed Nassar):

Hi there,

I noticed this issue has been open for several months and doesn't seem to
have active progress. I'm interested in contributing to this task.

Could you please:
- Confirm if this issue is still relevant?
- If the issue is still valid, would you be open to having me work on it?
- If you're no longer actively working on this, would you be willing to
unassign yourself so I can take it over?

I'm prepared to:
- Carefully review the current documentation
- Propose specific improvements
- Submit a pull request following Django's contribution guidelines

Thank you for your time and consideration.
--
Ticket URL: <https://code.djangoproject.com/ticket/35824#comment:3>

[Django]

#35824: Improve patch_cache_control documentation
-------------------------------------+-------------------------------------
Reporter: Adam Johnson | Owner: Waqas
Type: | Younas
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Adam Johnson):

Yes, it’s still relevant. Please try to understand the existing
documentation - cross-reference with MDN's documentation on the cache-
control header.
--
Ticket URL: <https://code.djangoproject.com/ticket/35824#comment:4>