1
65%
dev: 65%

Ran 26 Dec 2017 09:40AM UTC

Files 15

Run time 1s

Badge

Embed ▾

Committed 26 Dec 2017 09:38AM UTC coverage: 44.568% (-0.1%) from 44.693%

Job # 103.1

Build Type

push

travis-ci

Committed by

pkrawat1

Commit Message

Creditcard docs (#48)

* Defines the CreditCard "type" and adds docs

\# Why `CreditCard.t`?

If you read up on how to document Structs, you'll realise that
`CreditCard`, (the module) should not be used as a "type" -- because it
is a module, just a bunch of functions. This is related to the confusion
between `String` and `String.t`.

Composite types must be defined using @type. This helps static analysers
like Dialyser to actually perform type-checking.

\## Real World example

In the excellent swoosh lib:
https://github.com/swoosh/swoosh/search?utf8=%E2%9C%93&q=type+t+%3A%3A+%25__MODULE__%7Btype&type=

References:
https://www.reddit.com/r/elixir/comments/4v2ss2/help_me_understand_types_in_documentation_specs/
http://elixir-recipes.github.io/types/type-checking/
https://hexdocs.pm/elixir/typespecs.html#user-defined-types
https://stackoverflow.com/questions/29977776/what-does-type-t-module-mean-in-elixir

\# Other

Note that `:year` and `:month` are **integers**!

* Changed @specs in all gateway docs (CreditCard.t)

Notice that the typespecs now show `Gringotts.CreditCard.t`, (which is
clickable, unlike before!) instead of `Gringotts.CreditCard`

Run Details

160 of 359 relevant lines covered (44.57%)

1.88 hits per line

aviabird / gringotts / 103 / 1
65%
dev: 65%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job 103.1

aviabird / gringotts / 103 / 1 65% dev: 65%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job 103.1

aviabird / gringotts / 103 / 1
65%
dev: 65%

README BADGES
x