Enhancing documentation about filters
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 459
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
Migrated issue, originally created by Anonymous
Mako provide cool filters, but I think documentation can be enhanced explaining, in HTML, where to use which filter.
I mean, how to filter this :
${val1} <${val2} src="${val3}"/>
I was searching the right way to escape values of attributes, and got hard times to find it, Typically I'm a backend developper, not a front end, so I know that things has to be contextually escaped, but I don't exactly know which method escapes for which context.
So, presenting flags in http://docs.makotemplates.org/en/latest/filtering.html as a table, with 'name', 'explanation', 'usage contexts', 'example' should be usefull.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the filtering.html documentation page and review its existing filter descriptions. Organize the filter flags into a table with name, explanation, usage contexts, and an example, including HTML attribute escaping; done means the page clearly explains which filter applies in each context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100