Opened 13 months ago

Last modified 3 weeks ago

#35824 assigned Cleanup/optimization

Improve patch_cache_control documentation

Reported by: Adam Johnson Owned by: Samriddha Kumar Tripathi
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

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.

Change History (9)

comment:1 by Sarah Boyce, 13 months ago

Triage Stage: UnreviewedAccepted

Agreed - I think that would be a nice improvement

comment:2 by Waqas Younas, 13 months ago

Owner: set to Waqas Younas
Status: newassigned

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.

comment:3 by Ahmed Nassar, 8 months ago

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.

comment:4 by Adam Johnson, 7 months ago

Yes, it’s still relevant. Please try to understand the existing documentation - cross-reference with MDN's documentation on the cache-control header.

comment:5 by Samriddha Kumar Tripathi, 3 weeks ago

I would like to work on this ticket

comment:6 by Adam Johnson, 3 weeks ago

Go ahead!

comment:7 by Samriddha Kumar Tripathi, 3 weeks ago

Has patch: set
Owner: changed from Waqas Younas to Samriddha Kumar Tripathi
Patch needs improvement: set

comment:8 by Samriddha Kumar Tripathi, 3 weeks ago

PR -
https://github.com/django/django/pull/19922
Hi, I’ve started working on this and submitted a patch that improves the documentation around patch_cache_control. I’ve tried to align with Django’s doc style and linting requirements, but I’d appreciate any guidance or suggestions—especially if there’s a preferred way to present the table or examples.

Thanks in advance for your time and review!

comment:9 by Samriddha Kumar Tripathi, 3 weeks ago

Patch needs improvement: unset
Note: See TracTickets for help on using tickets.
Back to Top