diff --git a/docs/roadmap.md b/docs/roadmap.md index a2e32ab5..ce43ba64 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -89,8 +89,8 @@ configurations with variables, control flow, and custom functions. - [ ] **Dynamic Features and Custom Functions:** - [ ] Implement support for basic Jinja control structures (`{% if %}` and - `{% for %}`) - + `{% for %}`) + - [ ] Implement the foreach key for target generation. - [ ] Implement the essential custom Jinja function env(var_name) to read diff --git a/docs/srgn.md b/docs/srgn.md index 92703b77..eba354b1 100644 --- a/docs/srgn.md +++ b/docs/srgn.md @@ -95,7 +95,7 @@ supported 1: Bash - ```bash + ```sh # Install the Rust toolchain if you haven't already # Then, install cargo-binstall cargo install cargo-binstall @@ -110,7 +110,7 @@ supported 1: Bash - ```bash + ```sh cargo install srgn ``` @@ -142,7 +142,7 @@ example from the documentation 1: Bash -```bash +```sh echo 'Hello World!' | srgn '[wW]orld' -- 'there' # Output: Hello there! ``` @@ -179,7 +179,7 @@ For instance, to find all class definitions in a Python project, one could run: Bash -```bash +```sh srgn --python 'class'. ``` @@ -232,7 +232,7 @@ Consider the following command: Bash -```bash +```sh # Find all occurrences of 'github.com' but only inside docstrings of Python classes. srgn --python 'class' --python 'doc-strings' 'github\.com' my_project/ ``` @@ -268,7 +268,7 @@ A practical example from the release notes demonstrates its utility 9: Bash -```bash +```sh # Find all TODOs, whether they are in comments or docstrings. srgn -j --python comments --python doc-strings 'TODO:' src/ ``` @@ -310,7 +310,7 @@ once 2: Bash -```bash +```sh srgn --python 'doc-strings' '(?