Summary

Add a utility for lazily marking text as safe

Review Request #9961 — Created May 18, 2018 and submitted May 21, 2018, 4:04 p.m.

Information

Owner

brennie

Repository

Djblets

Branch

release-1.0.x

Bugs

Depends On

Commit

06e2821...

Reviewers

Groups

djblets

People

Description

This patch adds the djblets.util.html package, which is intended for
HTML-related utilities. Currently the only contents is the
mark_safe_lazy function, which is a lazily-executed version of
django.utils.safestring.mark_safe.

Testing Done

Issues

Description	From	Last Updated
Shouldn't this be a doc string instead of comments? If not, why is #: not simply #?	mandeep	May 18, 2018, 12:58 p.m.

flake8 passed.

JSHint passed.

djblets/util/html.py (Diff revision 1)

The issue has been dropped. Show all issues

Shouldn't this be a doc string instead of comments?
If not, why is #: not simply #?

brennie May 18, 2018, 1 p.m.

Because of the way lazy() works, it wraps the function you give it so it will have the docstring of that function.
The #:-style comments are recognized by Sphinx, our documentation generator, and extracted as if it were the docstring of the function.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-1.0.x (24bb628)