2
60%
master: 60%

Ran 16 Oct 2018 03:21PM UTC

Files 4

Run time 424min

Badge

Embed ▾

Committed 16 Oct 2018 03:19PM UTC coverage: 60.61%. Remained the same

Job # 121.2

Build Type

push

travis-ci

Committed by

web-flow

Commit Message

Merge pull request #34 from lydia-duncan/addThrowTags

Add support for a :throw(s): tag for functions and iterators
[reviewed by @ben-albrecht]

The formatting is similar to :arg name: (because that's how the example I saw
did it for Python errors), but it doesn't allow a :type name: extension
(because that seemed silly to me).  Throw lists should be after both arguments
and return types (because that's how it is in Chapel function declarations).

This supports both `:throw:` and `:throws:` (similar to how we support both
`:return:` and `:returns:`)

Example - for a function defined as:

```chapel
proc foo(x: int): string throws { ... }
```

We expect to write the following documentation:
```
Something about foo

:arg x: some number
:type x: `int`
:return: some message
:rtype: `string`
:throws SomeError: should some condition occur
:throws SomeDifferentError: should some other condition occur
```

Adds some documentation tests to verify that this works.

Run Details

477 of 787 relevant lines covered (60.61%)

0.61 hits per line

chapel-lang / sphinxcontrib-chapeldomain / 121 / 2
60%
master: 60%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job 121.2

chapel-lang / sphinxcontrib-chapeldomain / 121 / 2 60% master: 60%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job 121.2

chapel-lang / sphinxcontrib-chapeldomain / 121 / 2
60%
master: 60%

README BADGES
x