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.

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

Simplify the API #97

Closed
cdornan opened this issue Mar 29, 2017 · 0 comments
Closed

Simplify the API #97

cdornan opened this issue Mar 29, 2017 · 0 comments
Assignees
Labels
Milestone

Comments

@cdornan
Copy link
Contributor

@cdornan cdornan commented Mar 29, 2017

The API will be further simplified, reducing the amount of modules the user needs to consider while keeping them (as they are) quite small and simple, with the aim of reducing the cognitive load on the developer using the package top write some code.

  • Rename Internal to ZeInternals to get them dropped to the bottom of the Hackage page, not the top.

  • Move the Text.RE.TDFA.RE (and Text.RE.PCRE.RE) modules to Text.RE.ZeInternals.TDFA (PCRE).

  • Remove Text.RE.Types and move all of the the Text.RE.Types.* modules under
    ZeInternals, except

    • IsRegex, which becomes Text.RE.IsRegex.
    • REOptions which becomes Text.RE.REOptions;
  • Establish the following interface:

    • Text.RE.Replace.
  • Move Text.RE.TestBench under Text.RE.ZeInternals and convert
    Text.RE.TestBench.Parsers into the API module at Text.RE.TestBench.

@cdornan cdornan added the in progress label Mar 29, 2017
@cdornan cdornan added this to the v0.11.0.0 milestone Mar 29, 2017
@cdornan cdornan self-assigned this Mar 29, 2017
cdornan added a commit that referenced this issue Mar 29, 2017
  * Simplify API (fixes #97)
  * Rename Location to RELocation (fixes #98)
  * Rename the MacrosDescriptor Fields (fixes #99)
@cdornan cdornan closed this in #100 Mar 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

1 participant