[Documentation] Inconsistent jinja samples for filters added in version 3000
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description of Issue
The jinja filters added in version 3000 (set_dict_key_value, append_dict_key_value, extend_dict_key_value, update_dict_key_value) use inconsistent formatting for the examples, results, and version added blocks on the Understanding Jinja page (https://docs.saltstack.com/en/latest/topics/jinja/index.html). All of the other filters contain the examples and returns in their respective boxes but these filters just have them in raw.
New filter:
Old filter:
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
Open the Understanding Jinja page linked in the issue and inspect the documentation for set_dict_key_value, append_dict_key_value, extend_dict_key_value, and update_dict_key_value. Compare their examples, returns, and version-added blocks with the surrounding filters. Done means all four use the same rendered boxes and formatting as the other filters.
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
- 45/100