exercism/python
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Docs and macros improvements (#2084)

Browse Source 
* Document builtin template filters

* do not require explicit _has_error_case param for footer macro, but still allow it
This commit is contained in:
Corey McCandless
2019-10-22 10:56:24 -04:00
committed by GitHub
parent 571dcd2257
commit b965863ec9
13 changed files with 27 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/GENERATOR.md
View File

@@ -34,6 +34,12 @@ structure for the exercise you're working on, please consult
error to be thrown (ex: `False`)
- `additional_cases`: similar structure to `cases`, but is populated from the exercise's `.meta/additional_tests.json` file if one exists (for an example, see `exercises/word-count/.meta/additional_tests.json`)
Additionally, the following template filters are added for convenience:
- `to_snake`: Converts a string to snake_case (ex: `{{ "CamelCaseString" | to_snake }}` -> `camel_case_string`)
- `camel_case`: Converts a string to CamelCase (ex: `{{ "snake_case_string" | camel_case }}` -> `SnakeCaseString` )
- `error_case`: Checks if a test case expects an error to be thrown (ex: `{% for case in cases%}{% if case is error_case}`)
- `regex_replace`: Regex string replacement (ex: `{{ "abc123" | regex_replace("\\d", "D") }}` -> `abcDDD`)
### Conventions
- General-use macros for highly repeated template structures are defined in `config/generator_macros.j2`.