{"action":"created","issue":{"url":"https://api.github.com/repos/landlab/landlab/issues/587","repository_url":"https://api.github.com/repos/landlab/landlab","labels_url":"https://api.github.com/repos/landlab/landlab/issues/587/labels{/name}","comments_url":"https://api.github.com/repos/landlab/landlab/issues/587/comments","events_url":"https://api.github.com/repos/landlab/landlab/issues/587/events","html_url":"https://github.com/landlab/landlab/pull/587","id":273206323,"number":587,"title":"Fix signatures of decorated functions","user":{"login":"mcflugen","id":6618196,"avatar_url":"https://avatars1.githubusercontent.com/u/6618196?v=4","gravatar_id":"","url":"https://api.github.com/users/mcflugen","html_url":"https://github.com/mcflugen","followers_url":"https://api.github.com/users/mcflugen/followers","following_url":"https://api.github.com/users/mcflugen/following{/other_user}","gists_url":"https://api.github.com/users/mcflugen/gists{/gist_id}","starred_url":"https://api.github.com/users/mcflugen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mcflugen/subscriptions","organizations_url":"https://api.github.com/users/mcflugen/orgs","repos_url":"https://api.github.com/users/mcflugen/repos","events_url":"https://api.github.com/users/mcflugen/events{/privacy}","received_events_url":"https://api.github.com/users/mcflugen/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"mcflugen","id":6618196,"avatar_url":"https://avatars1.githubusercontent.com/u/6618196?v=4","gravatar_id":"","url":"https://api.github.com/users/mcflugen","html_url":"https://github.com/mcflugen","followers_url":"https://api.github.com/users/mcflugen/followers","following_url":"https://api.github.com/users/mcflugen/following{/other_user}","gists_url":"https://api.github.com/users/mcflugen/gists{/gist_id}","starred_url":"https://api.github.com/users/mcflugen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mcflugen/subscriptions","organizations_url":"https://api.github.com/users/mcflugen/orgs","repos_url":"https://api.github.com/users/mcflugen/repos","events_url":"https://api.github.com/users/mcflugen/events{/privacy}","received_events_url":"https://api.github.com/users/mcflugen/received_events","type":"User","site_admin":false},"assignees":[{"login":"mcflugen","id":6618196,"avatar_url":"https://avatars1.githubusercontent.com/u/6618196?v=4","gravatar_id":"","url":"https://api.github.com/users/mcflugen","html_url":"https://github.com/mcflugen","followers_url":"https://api.github.com/users/mcflugen/followers","following_url":"https://api.github.com/users/mcflugen/following{/other_user}","gists_url":"https://api.github.com/users/mcflugen/gists{/gist_id}","starred_url":"https://api.github.com/users/mcflugen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mcflugen/subscriptions","organizations_url":"https://api.github.com/users/mcflugen/orgs","repos_url":"https://api.github.com/users/mcflugen/repos","events_url":"https://api.github.com/users/mcflugen/events{/privacy}","received_events_url":"https://api.github.com/users/mcflugen/received_events","type":"User","site_admin":false}],"milestone":null,"comments":1,"created_at":"2017-11-12T06:22:03Z","updated_at":"2017-11-12T07:45:50Z","closed_at":null,"author_association":"OWNER","pull_request":{"url":"https://api.github.com/repos/landlab/landlab/pulls/587","html_url":"https://github.com/landlab/landlab/pull/587","diff_url":"https://github.com/landlab/landlab/pull/587.diff","patch_url":"https://github.com/landlab/landlab/pull/587.patch"},"body":"This pull request adds real function signatures to the first line of docstrings decorated with `use_file_name_or_kwds` and `use_field_name_or_array`. Both of these decorators change the function signature to `(*args, **kwds)` which means that help messages and our sphinx-generated documentation show this signature rather than the real signature. By placing the real signature on the first line of the docstring, sphinx uses this as the signature. This make the documentation more sensible and removes the need to include a *Construction* block in docstrings.\r\n\r\nI've also set `autoclass_content = 'both'` in `conf.py`. This tells sphinx to concatenate class docstrings with the `__init__` docstring of the class. This means the *Parameters* bock of the class constructor can go (sensibly) under `__init__` while the class docstring can provide a more general description and examples."},"comment":{"url":"https://api.github.com/repos/landlab/landlab/issues/comments/343719533","html_url":"https://github.com/landlab/landlab/pull/587#issuecomment-343719533","issue_url":"https://api.github.com/repos/landlab/landlab/issues/587","id":343719533,"user":{"login":"coveralls","id":2354108,"avatar_url":"https://avatars1.githubusercontent.com/u/2354108?v=4","gravatar_id":"","url":"https://api.github.com/users/coveralls","html_url":"https://github.com/coveralls","followers_url":"https://api.github.com/users/coveralls/followers","following_url":"https://api.github.com/users/coveralls/following{/other_user}","gists_url":"https://api.github.com/users/coveralls/gists{/gist_id}","starred_url":"https://api.github.com/users/coveralls/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/coveralls/subscriptions","organizations_url":"https://api.github.com/users/coveralls/orgs","repos_url":"https://api.github.com/users/coveralls/repos","events_url":"https://api.github.com/users/coveralls/events{/privacy}","received_events_url":"https://api.github.com/users/coveralls/received_events","type":"User","site_admin":false},"created_at":"2017-11-12T07:45:50Z","updated_at":"2017-11-12T07:45:50Z","author_association":"NONE","body":"\n[![Coverage Status](https://coveralls.io/builds/14158316/badge)](https://coveralls.io/builds/14158316)\n\nCoverage increased (+0.005%) to 79.606% when pulling **2a79a67064c4ee1c72021221b95738557c0675b1 on mcflugen/fix-component-signatures** into **fe23470fd2b8acb371c1029cd3e92dd18c535a25 on master**.\n"}}
{"actor":{"display_login":"coveralls"}}