chapel-lang / sphinxcontrib-chapeldomain / 121

60%

push

travis-ci

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.

2 of 2 new or added lines in 1 file covered. (100.0%)

477 of 787 relevant lines covered (60.61%)

1.21 hits per line