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

API tweaks #50

Merged
merged 13 commits into from
Feb 26, 2017
Merged

API tweaks #50

merged 13 commits into from
Feb 26, 2017

Conversation

cdornan
Copy link
Contributor

@cdornan cdornan commented Feb 26, 2017

v0.3.0.0 Tidy the API and start preparation for next weeks announcement (2017-03-07).

Not all of the APi have been using the standard cammelcase Haskell
conventions for identifiers. That should be fixed now.
Also cabal templates are now a bit DRYer.
  * by switching to a single-line format for the example calculations
    we can somewhat simplify the tutorial document generator
    (it is now stateless), and the whole tutorial processor
    (no need to process begin, end lines;

  * calculation lines now are all single lines, matching
    ghci (it was simple blunder to do otherwise);

  * the tutorial documentation do auto-shows the expressions
    and answers as ghci interactions.

TLDR: the tutorial processor and tutorial are simpler and better.
The API modules (the ones containing the match operators for the
various backends and text tyopes) have been properly haddocked.
Standard GFM displays the protocol in the derived HTML, but
we prefer not to display it -- especiallt in the directory page.
@cdornan cdornan changed the title Api tweaks API tweaks Feb 26, 2017
@coveralls
Copy link

Coverage Status

Coverage increased (+0.3%) to 95.32% when pulling 76b2123 on api-tweaks into 66af84f on master.

@cdornan cdornan merged commit 3bcebbf into master Feb 26, 2017
@cdornan cdornan deleted the api-tweaks branch February 27, 2017 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants