Changes between Version 1 and Version 2 of Ticket #36000, comment 10


Ignore:
Timestamp:
Mar 8, 2025, 6:29:02 PM (6 months ago)
Author:
Ahmed Nassar

Legend:

Unmodified
Added
Removed
Modified

  • Ticket #36000, comment 10

    v1 v2  
    1 I've updated the PR with improved documentation and fixed all sphinx-build warnings:
     1The issue regarding defaulting to HTTP instead of HTTPS in urlize has been addressed. A fix has been implemented to ensure that URLs without a specified protocol now default to HTTPS, improving security and preventing potential MITM attacks.
    22
    3 Changes made:
    4 - Added detailed documentation for urlize() function in docs/ref/utils.txt
    5 - Fixed sphinx-build warnings related to function references
    6 - Added proper parameter descriptions following Django's style
    7 - Included a practical example showing function usage
    8 - Followed Django's documentation guidelines
    9 - All documentation now builds without warnings
     3🔗 Pull Request: #19240
    104
    11 Documentation improvements:
    12 - Added :param: descriptions for all parameters
    13 - Added clear return value description
    14 - Added working code example
    15 - Fixed cross-references between template filter and utility function
    16 - Maintained consistent documentation style
     5Summary of Fix:
     6✅ Updated urlize to default to HTTPS when no protocol is provided.
     7✅ Ensured backward compatibility with a transitional URLIZE_ASSUME_HTTPS setting.
     8✅ Followed Django's deprecation plan for smooth transition in future versions.
     9✅ Added relevant tests to confirm correct behavior.
    1710
    18 The PR now includes:
    19 1. URLIZE_ASSUME_HTTPS setting implementation
    20 2. Deprecation warning for http:// default
    21 3. Complete test coverage
    22 4. Comprehensive documentation
    23 5. Release notes
     11The changes have been tested, and everything appears to be working as expected. Please review when possible and let me know if any adjustments are needed.
    2412
    25 PR: https://github.com/django/django/pull/19240
    26 
    27 All checks are passing and the documentation builds cleanly. Ready for review.
     13Looking forward to your feedback!
Back to Top