Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Meaning of blankCompOpt is not documented #13

Closed
raxod502 opened this issue May 12, 2020 · 1 comment · Fixed by #40
Closed

Meaning of blankCompOpt is not documented #13

raxod502 opened this issue May 12, 2020 · 1 comment · Fixed by #40
Labels
documentation Improvements or additions to documentation

Comments

@raxod502
Copy link

The documentation for CompOption details two different values for each field, one for defaultCompOpt and one for blankCompOpt. However, neither of these variables are documented. I assume that defaultCompOpt is used if you use one of the convenience functions to construct a regex from a string (although #11 makes me unsure of this), but I cannot see where blankCompOpt is used even in the code. Why are there two variables?
@andreasabel andreasabel added the documentation Improvements or additions to documentation label Jul 15, 2022
@andreasabel
Copy link
Member

They are part of the regex-base package, see, e.g. https://hackage.haskell.org/package/regex-base-0.94.0.2/docs/Text-Regex-Base-RegexLike.html#v:blankCompOpt.

@andreasabel andreasabel mentioned this issue Jul 15, 2022
Merged
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Aug 18, 2022
@0-wiz-0
hs-regex-tdfa: update to 1.3.2.
a357b52 
### 1.3.2

_2022-07-18, Andreas Abel_

- Export `decodePatternSet` and `decodeCharacterClass` from `Text.Regex.TDFA.Pattern`
  ([#16](haskell-hvr/regex-tdfa#16))
- Extend and correct docs for `Pattern` module
- Tested with GHC 7.4 - 9.4

### 1.3.1.5

_2022-07-18, Andreas Abel_

- Allow dash (`-`) as start of a range, e.g. `[--z]`
  ([#1](haskell-hvr/regex-tdfa#1),
  [#45](haskell-hvr/regex-tdfa#45))
- Tested with GHC 7.4 - 9.4

### 1.3.1.4

_2022-07-17, Andreas Abel_

- Fix parsing of dashes in bracket expressions, e.g. `[-a-z]` ([#1](haskell-hvr/regex-tdfa#1))
- Fix a deprecation warning except for on GHC 8.2 ([#21](haskell-hvr/regex-tdfa#21))
- Documentation: link `defaultComptOpt` to its definition  ([#13](haskell-hvr/regex-tdfa#13))
- Verify documentation examples with new `doc-test` testsuite
- Tested with GHC 7.4 - 9.4

### 1.3.1.3

_2022-07-14, Andreas Abel_

- Fix an `undefined` in `Show PatternSet` ([#37](haskell-hvr/regex-tdfa#37))
- Document POSIX character classes (e.g. `[[:digit:]]`) in README
- Tested with GHC 7.4 - 9.4

### 1.3.1.2 Revision 1

_2022-05-25, Andreas Abel_

- Allow `base >= 4.17` (GHC 9.4)

### 1.3.1.2

_2022-02-19, Andreas Abel_
- No longer rely on the `MonadFail` instance for `ST`
  (future `base` library change, see [#29](haskell-hvr/regex-tdfa#29)).
- Silence warning `incomplete-uni-patterns` (GHC >= 9.2).
- Import from `Data.List` explicitly or qualified (warning `compat-unqualified-imports`).
- Import from `Control.Monad` to allow `mtl-2.3` in its `rc3` incarnation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix #13 by linking documentation of defaultCompOpt (regex-base) haskell-hvr/regex-tdfa
2 participants
@andreasabel @raxod502