Przeglądaj źródła

Update readme

tags/v0.1.3
Garrick Aden-Buie 8 lat temu
rodzic
commit
8dbc571ddb
2 zmienionych plików z 43 dodań i 10 usunięć
  1. +20
    -4
      Readme.Rmd
  2. +23
    -6
      Readme.md

+ 20
- 4
Readme.Rmd Wyświetl plik



## Status ## Status


Mostly working, but there [may be issues or future changes](#issues).
Mostly working, but there [may be issues or future changes](#known-issues-and-future-work).


I would love your help testing this, feel free to send me your feedback on Twitter at [@grrrck](https://twitter.com/grrrck) or through the [issue tracker](https://github.com/gadenbuie/regexplain). I would love your help testing this, feel free to send me your feedback on Twitter at [@grrrck](https://twitter.com/grrrck) or through the [issue tracker](https://github.com/gadenbuie/regexplain).




#### Things I know are wonky #### Things I know are wonky


- Things get weird when regular text is surrounded by capture groups, i.e. `"(\w+) not grouped (\w+)"`.

- `view_regex()` colorizes non-capture groups. I forgot about them when building that feature, I'll get back to it. - `view_regex()` colorizes non-capture groups. I forgot about them when building that feature, I'll get back to it.


#### Notes #### Notes


#### Planned improvements #### Planned improvements


- Make better use of the opening view of **Help** tab to explain the gadget.
Also add one or more additional tabs with an overview of regular expressions,
with links to R4DS and `vignette('regular-expressions', package = 'stringr')`.
Maybe also a **Try This** feature that sets the `text` and `pattern` with
regex challenges (possibly borrowed from R4DS).

- Add a global search option to the **Regex** tab. Groups would be lost, but I
can still highlight global matches.

- Add "flavors" menu to **Regex** tab. Automatically sets options to common flavors.
Mainly for clarity when switching between "base"" style and "tidyverse/stringr" defaults.
- Add replacement functions somewhere. Maybe to **Output** tab with `g?sub` and
`str_replace(_all)?` as options with an additional "replacement" field that
appears when those are selected. Or possibly as a "flavor" (see above) in the
**Regex** tab.

- I may add `stringi` functions to the list of available functions in the **Output** tab. - I may add `stringi` functions to the list of available functions in the **Output** tab.


- I would like to add the regex/function options for the functions in the **Output** tab, similar to the options present in the **Regex** tab.
- I would like to add the regex/function options for the functions in the **Output** tab, i
similar to the options present in the **Regex** tab.

+ 23
- 6
Readme.md Wyświetl plik



## Status ## Status


Mostly working, but there [may be issues or future changes](#issues).
Mostly working, but there [may be issues or future
changes](#known-issues-and-future-work).


I would love your help testing this, feel free to send me your feedback I would love your help testing this, feel free to send me your feedback
on Twitter at [@grrrck](https://twitter.com/grrrck) or through the on Twitter at [@grrrck](https://twitter.com/grrrck) or through the


#### Things I know are wonky #### Things I know are wonky


- Things get weird when regular text is surrounded by capture groups,
i.e. `"(\w+) not grouped (\w+)"`.

- `view_regex()` colorizes non-capture groups. I forgot about them - `view_regex()` colorizes non-capture groups. I forgot about them
when building that feature, I’ll get back to it. when building that feature, I’ll get back to it.




#### Planned improvements #### Planned improvements


- Make better use of the opening view of **Help** tab to explain the
gadget. Also add one or more additional tabs with an overview of
regular expressions, with links to R4DS and
`vignette('regular-expressions', package = 'stringr')`. Maybe also a
**Try This** feature that sets the `text` and `pattern` with regex
challenges (possibly borrowed from R4DS).

- Add a global search option to the **Regex** tab. Groups would be
lost, but I can still highlight global matches.

- Add “flavors” menu to **Regex** tab. Automatically sets options to
common flavors. Mainly for clarity when switching between “base”"
style and “tidyverse/stringr” defaults.

- Add replacement functions somewhere. Maybe to **Output** tab with
`g?sub` and `str_replace(_all)?` as options with an additional
“replacement” field that appears when those are selected. Or
possibly as a “flavor” (see above) in the **Regex** tab.

- I may add `stringi` functions to the list of available functions in - I may add `stringi` functions to the list of available functions in
the **Output** tab. the **Output** tab.


- I would like to add the regex/function options for the functions in - I would like to add the regex/function options for the functions in
the **Output** tab, similar to the options present in the **Regex**
tab.
the **Output** tab, i similar to the options present in the
**Regex** tab.

Ładowanie…
Anuluj
Zapisz