{"action":"created","issue":{"url":"https://api.github.com/repos/numpy/numpydoc/issues/136","repository_url":"https://api.github.com/repos/numpy/numpydoc","labels_url":"https://api.github.com/repos/numpy/numpydoc/issues/136/labels{/name}","comments_url":"https://api.github.com/repos/numpy/numpydoc/issues/136/comments","events_url":"https://api.github.com/repos/numpy/numpydoc/issues/136/events","html_url":"https://github.com/numpy/numpydoc/pull/136","id":270249055,"number":136,"title":"Ensure reference renaming is parallel-safe","user":{"login":"jnothman","id":78827,"avatar_url":"https://avatars2.githubusercontent.com/u/78827?v=4","gravatar_id":"","url":"https://api.github.com/users/jnothman","html_url":"https://github.com/jnothman","followers_url":"https://api.github.com/users/jnothman/followers","following_url":"https://api.github.com/users/jnothman/following{/other_user}","gists_url":"https://api.github.com/users/jnothman/gists{/gist_id}","starred_url":"https://api.github.com/users/jnothman/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jnothman/subscriptions","organizations_url":"https://api.github.com/users/jnothman/orgs","repos_url":"https://api.github.com/users/jnothman/repos","events_url":"https://api.github.com/users/jnothman/events{/privacy}","received_events_url":"https://api.github.com/users/jnothman/received_events","type":"User","site_admin":false},"labels":[{"id":490804738,"url":"https://api.github.com/repos/numpy/numpydoc/labels/needs-decision","name":"needs-decision","color":"eb6420","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":12,"created_at":"2017-11-01T09:34:47Z","updated_at":"2017-12-26T03:22:28Z","closed_at":null,"author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/numpy/numpydoc/pulls/136","html_url":"https://github.com/numpy/numpydoc/pull/136","diff_url":"https://github.com/numpy/numpydoc/pull/136.diff","patch_url":"https://github.com/numpy/numpydoc/pull/136.patch"},"body":"Fixes #112. Builds upon #135. Makes #130 (breaking table whitespace) worse, but see below.\r\n\r\nAlso fixes #114\r\n\r\nAt autodoc-process-docstring time, this prefixes each reference with a token indicative of which docstring it belongs to and then relabels the text of the reference in the doctree once the reST is parsed. The rendered reference naming therefore reflects what was in the original reST, rather than something with prefixes etc. So you get [1] rather than [R1].\r\n\r\nI'm not sure how to rigorously test this but will post some images soon.\r\n\r\nThe issue of breaking table whitespace (#130) is more minor than #112. It is exacerbated by this patch since references become much longer. There may be a more ideal solution that involves post-processing the doctrees to do *all* of the reference renaming (i.e. without this decorate-and-undecorate approach), but when I tried to implement it, I realised it would involve hacking footnotes to become citations, handling initial broken resolutions (incl `docutils.nodes.problematic`), and other madness. It may come later. In the meantime I think we should just tell users that citations cannot be used in tables."},"comment":{"url":"https://api.github.com/repos/numpy/numpydoc/issues/comments/353910968","html_url":"https://github.com/numpy/numpydoc/pull/136#issuecomment-353910968","issue_url":"https://api.github.com/repos/numpy/numpydoc/issues/136","id":353910968,"user":{"login":"rgommers","id":98330,"avatar_url":"https://avatars3.githubusercontent.com/u/98330?v=4","gravatar_id":"","url":"https://api.github.com/users/rgommers","html_url":"https://github.com/rgommers","followers_url":"https://api.github.com/users/rgommers/followers","following_url":"https://api.github.com/users/rgommers/following{/other_user}","gists_url":"https://api.github.com/users/rgommers/gists{/gist_id}","starred_url":"https://api.github.com/users/rgommers/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rgommers/subscriptions","organizations_url":"https://api.github.com/users/rgommers/orgs","repos_url":"https://api.github.com/users/rgommers/repos","events_url":"https://api.github.com/users/rgommers/events{/privacy}","received_events_url":"https://api.github.com/users/rgommers/received_events","type":"User","site_admin":false},"created_at":"2017-12-26T03:22:28Z","updated_at":"2017-12-26T03:22:28Z","author_association":"OWNER","body":"I set myself a reminder to check this on the numpy and scipy html/latex builds in the second week of January. If that all looks good then I'm going to merge this, unless there's other opinions by then. (of course if someone wants to merge it sooner after reviewing, please do)"}}
{"actor":{"display_login":"rgommers"}}