Skip to content
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

Make users more reluctant to use unsafe functions #35

Open
meiersi opened this issue Dec 31, 2010 · 0 comments
Open

Make users more reluctant to use unsafe functions #35

meiersi opened this issue Dec 31, 2010 · 0 comments

Comments

@meiersi
Copy link
Collaborator

meiersi commented Dec 31, 2010

One of the core goals of blaze-html is to guide the user towards writing well-formed, well-escaped Html documents. Therefore, I suggest that we improve the documentation as follows:

  1. Use a separate section for the unsafe/preEscaped functions in every module documentation.
  2. Mark the work 'unsafe' in bold and ensure that all reasons for why the functions is unsafe, is listed.
  3. Perhaps we could even have a small intro about XSS attacks on the main documentation page. This way the users would be more sensitive to the problem.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant