{"action":"created","issue":{"url":"https://api.github.com/repos/lsst/pex_config/issues/21","repository_url":"https://api.github.com/repos/lsst/pex_config","labels_url":"https://api.github.com/repos/lsst/pex_config/issues/21/labels{/name}","comments_url":"https://api.github.com/repos/lsst/pex_config/issues/21/comments","events_url":"https://api.github.com/repos/lsst/pex_config/issues/21/events","html_url":"https://github.com/lsst/pex_config/pull/21","id":304440730,"number":21,"title":"ReST-ify config doc strings","user":{"login":"SimonKrughoff","id":945715,"avatar_url":"https://avatars2.githubusercontent.com/u/945715?v=4","gravatar_id":"","url":"https://api.github.com/users/SimonKrughoff","html_url":"https://github.com/SimonKrughoff","followers_url":"https://api.github.com/users/SimonKrughoff/followers","following_url":"https://api.github.com/users/SimonKrughoff/following{/other_user}","gists_url":"https://api.github.com/users/SimonKrughoff/gists{/gist_id}","starred_url":"https://api.github.com/users/SimonKrughoff/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SimonKrughoff/subscriptions","organizations_url":"https://api.github.com/users/SimonKrughoff/orgs","repos_url":"https://api.github.com/users/SimonKrughoff/repos","events_url":"https://api.github.com/users/SimonKrughoff/events{/privacy}","received_events_url":"https://api.github.com/users/SimonKrughoff/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2018-03-12T16:17:48Z","updated_at":"2018-03-13T20:47:01Z","closed_at":null,"author_association":"NONE","pull_request":{"url":"https://api.github.com/repos/lsst/pex_config/pulls/21","html_url":"https://github.com/lsst/pex_config/pull/21","diff_url":"https://github.com/lsst/pex_config/pull/21.diff","patch_url":"https://github.com/lsst/pex_config/pull/21.patch"},"body":"This changes how the default Field constructor handles the `doc` argument.  It also changes how `ChoiceField` and `RangeField` handle `self.__doc__`.\r\n\r\nExample base `Field`, `RangeField` and `ChoiceField`:\r\n``` \r\n |  doWriteExposure\r\n |      Write icExp and icExpBackground in addition to icSrc? Ignored if doWrite False. (`bool`)\r\n |  \r\n |  psfIterations\r\n |      Number of iterations of detect sources, measure sources, estimate PSF. If useSimplePsf is True then 2 should be plenty; otherwise more may be wanted. (`int`)\r\n |      \r\n |      Valid Range = [1,inf)\r\n |\r\n |  flatScalingType\r\n |      The method for scaling the flat on the fly. (`str`)\r\n |      \r\n |      Allowed values:\r\n |      \r\n |      USER\r\n |        Scale by flatUserScale\r\n |      MEAN\r\n |        Scale by the inverse of the mean\r\n |      MEDIAN\r\n |        Scale by the inverse of the median\r\n |      None\r\n |        Field is optional\r\n```"},"comment":{"url":"https://api.github.com/repos/lsst/pex_config/issues/comments/372812769","html_url":"https://github.com/lsst/pex_config/pull/21#issuecomment-372812769","issue_url":"https://api.github.com/repos/lsst/pex_config/issues/21","id":372812769,"user":{"login":"jonathansick","id":349384,"avatar_url":"https://avatars3.githubusercontent.com/u/349384?v=4","gravatar_id":"","url":"https://api.github.com/users/jonathansick","html_url":"https://github.com/jonathansick","followers_url":"https://api.github.com/users/jonathansick/followers","following_url":"https://api.github.com/users/jonathansick/following{/other_user}","gists_url":"https://api.github.com/users/jonathansick/gists{/gist_id}","starred_url":"https://api.github.com/users/jonathansick/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jonathansick/subscriptions","organizations_url":"https://api.github.com/users/jonathansick/orgs","repos_url":"https://api.github.com/users/jonathansick/repos","events_url":"https://api.github.com/users/jonathansick/events{/privacy}","received_events_url":"https://api.github.com/users/jonathansick/received_events","type":"User","site_admin":false},"created_at":"2018-03-13T20:47:01Z","updated_at":"2018-03-13T20:47:01Z","author_association":"OWNER","body":"Exactly, for those choice fields, it might be good if the value was marked up as a code literal:\r\n\r\n```rst\r\n``'simplePoly'``\r\n    One Polynomial per ccd.\r\n```\r\n\r\nI think you could do something like\r\n\r\n```python\r\n``{0:r}``.format(defaultValue)\r\n```\r\n\r\nTo let Python add the quotes around string values."}}
{"actor":{"display_login":"jonathansick"}}