chapel-lang / sphinxcontrib-chapeldomain

61%

master: 60%

LAST BUILD ON BRANCH 0.0.11

branch: 0.0.11

CHANGE BRANCH

x

Reset

• 0.0.11
• 0.0.10
• 0.0.12
• 0.0.13
• 0.0.14
• 0.0.15
• 0.0.16
• 0.0.17
• 0.0.18
• 0.0.19
• 0.0.2
• 0.0.20
• 0.0.3
• 0.0.4
• 0.0.5
• master

Build # 80

Build Type

push

travis-ci

Committed by thomasvandoren

Commit Message

Merge pull request #21 from thomasvandoren/param-type-format

Update argument type formatting to be more chapelerific.

Update argument type formatting to use the form `argname : type -- description`,
instead of `argname (type) -- description`. The new form is considered more
"chapelerific" since it matches the argument type syntax.

Unfortunately the sphinx.utils.docfields.TypedField.make_field() method is not
implemented in such a way that allows this formatting change without fully
overriding the meth. So, copy the TypedField.make_field() method from Sphinx
version 1.2.3 and modify the two Text() nodes that add the parentheses.

Because of how ChapelTypedField.make_field() is implemented, this package
is not dependent on Sphinx 1.2.x. There is probably a way to support both
Sphinx 1.2.x and the recently released Sphinx 1.3.x, but that is beyond the
scope of this change. In an ideal world, the three formatting strings in
TypedField.make_field() (`' ('`, `')'`, and `' -- '`) would be configurable without
needing to override make_field().

The source from Sphinx 1.2.3 can be found here:

https://github.com/sphinx-doc/sphinx/blob/1.2.3/sphinx/util/docfields.py#L137-166

r: @lydia-duncan

Run Details

477 of 787 relevant lines covered (60.61%)

1.21 hits per line