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

Issue 4 documentation #9

Merged
merged 8 commits into from
Jul 22, 2016
Merged

Issue 4 documentation #9

merged 8 commits into from
Jul 22, 2016

Conversation

noelmarkham
Copy link
Collaborator

@noelmarkham noelmarkham commented Jul 21, 2016

Microsites documentation for the library, integrated with Tut.

If you want to read it on the Microsites rendered page, run sbt docs/tut, and then it should be available in a Jekyll build: run jekyll server in docs/src/jekyll, then visit http://127.0.0.1:4000/scalacheck-datetime/

Also added Arbitrary instances, and appropriate tests.

@raulraja @FPerezP @franciscodr @diesalbla - would you be able to take a look when you get a chance please? In my opinion, this should be sufficient for a 0.1 release.

Resolves #4

@codecov-io
Copy link

codecov-io commented Jul 21, 2016

Current coverage is 100% (diff: 100%)

Merging #9 into master will not change coverage

@@           master    #9   diff @@
===================================
  Files           8     8          
  Lines          76    78     +2   
  Methods        76    78     +2   
  Messages        0     0          
  Branches        0     0          
===================================
+ Hits           76    78     +2   
  Misses          0     0          
  Partials        0     0          

Powered by Codecov. Last update d92009b...49d2889

---
layout: home
technologies:
- scala: ["Scala", "Lorem ipsum dolor sit amet, conse ctetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolo…"]
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, forgot about this - will fix.

require 'open-uri'
require 'uri'

class Jekyll::IncludeRemoteTag < Jekyll::Tags::IncludeTag
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if there is a way to provide all of of these includes also so that projects don't have to include jekyll sources themselves. Not related to this PR though, I know all projects have it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a git submodule, though those are notoriously tricky to work with.

@raulraja
Copy link
Contributor

Excellent docs and great work @noelmarkham!
I think we can benefit down the road from a couple of real world test cases in an examples section.
Also let's add the codecov badge and others that are appropriate to the README.

LGTM! Merge at will.

@noelmarkham noelmarkham merged commit 66d6ce5 into master Jul 22, 2016
@noelmarkham noelmarkham deleted the issue-4-documentation branch July 22, 2016 11:52
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.

3 participants