{"action":"created","issue":{"url":"https://api.github.com/repos/ocaml/odoc/issues/243","repository_url":"https://api.github.com/repos/ocaml/odoc","labels_url":"https://api.github.com/repos/ocaml/odoc/issues/243/labels{/name}","comments_url":"https://api.github.com/repos/ocaml/odoc/issues/243/comments","events_url":"https://api.github.com/repos/ocaml/odoc/issues/243/events","html_url":"https://github.com/ocaml/odoc/issues/243","id":378021274,"node_id":"MDU6SXNzdWUzNzgwMjEyNzQ=","number":243,"title":"Limit reference kind syntax to only what is supported by ocamldoc, where we have redundancy (suggestion)","user":{"login":"aantron","id":12073668,"node_id":"MDQ6VXNlcjEyMDczNjY4","avatar_url":"https://avatars2.githubusercontent.com/u/12073668?v=4","gravatar_id":"","url":"https://api.github.com/users/aantron","html_url":"https://github.com/aantron","followers_url":"https://api.github.com/users/aantron/followers","following_url":"https://api.github.com/users/aantron/following{/other_user}","gists_url":"https://api.github.com/users/aantron/gists{/gist_id}","starred_url":"https://api.github.com/users/aantron/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aantron/subscriptions","organizations_url":"https://api.github.com/users/aantron/orgs","repos_url":"https://api.github.com/users/aantron/repos","events_url":"https://api.github.com/users/aantron/events{/privacy}","received_events_url":"https://api.github.com/users/aantron/received_events","type":"User","site_admin":false},"labels":[{"id":446828030,"node_id":"MDU6TGFiZWw0NDY4MjgwMzA=","url":"https://api.github.com/repos/ocaml/odoc/labels/parser","name":"parser","color":"faecbb","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2018-11-06T20:32:02Z","updated_at":"2018-11-07T22:08:43Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"ocamldoc supports these qualifiers for reference path components: http://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html#sec359, at a glance in odoc:\r\n\r\nhttps://github.com/ocaml/odoc/blob/e8f7dcf218ceaa0da89e16ec2936c8a0cc3efe41/src/parser/reference.ml#L5-L20\r\n\r\nodoc supports additional qualifiers:\r\n\r\nhttps://github.com/ocaml/odoc/blob/e8f7dcf218ceaa0da89e16ec2936c8a0cc3efe41/src/parser/reference.ml#L22-L34\r\n\r\nAs can be seen, there is some overlap, where odoc supports alternative syntax for qualifiers already supported by ocamldoc. The suggestion is to remove support for the redundant qualifiers added by odoc. We will still need some qualifiers over ocamldoc, such as `page` and `extension`.\r\n\r\ncc @trefis"},"comment":{"url":"https://api.github.com/repos/ocaml/odoc/issues/comments/436795826","html_url":"https://github.com/ocaml/odoc/issues/243#issuecomment-436795826","issue_url":"https://api.github.com/repos/ocaml/odoc/issues/243","id":436795826,"node_id":"MDEyOklzc3VlQ29tbWVudDQzNjc5NTgyNg==","user":{"login":"aantron","id":12073668,"node_id":"MDQ6VXNlcjEyMDczNjY4","avatar_url":"https://avatars2.githubusercontent.com/u/12073668?v=4","gravatar_id":"","url":"https://api.github.com/users/aantron","html_url":"https://github.com/aantron","followers_url":"https://api.github.com/users/aantron/followers","following_url":"https://api.github.com/users/aantron/following{/other_user}","gists_url":"https://api.github.com/users/aantron/gists{/gist_id}","starred_url":"https://api.github.com/users/aantron/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aantron/subscriptions","organizations_url":"https://api.github.com/users/aantron/orgs","repos_url":"https://api.github.com/users/aantron/repos","events_url":"https://api.github.com/users/aantron/events{/privacy}","received_events_url":"https://api.github.com/users/aantron/received_events","type":"User","site_admin":false},"created_at":"2018-11-07T22:08:43Z","updated_at":"2018-11-07T22:08:43Z","author_association":"CONTRIBUTOR","body":"Yes, I agree with that too :)\r\n\r\nFor the next release, I'll change odoc to warn when it encounters the redundant qualifier strings, and accept them. After some time, we can remove support for them. Then, any docs that still use them will suffer the ordinary recovery from an invalid reference, which is that the reference will not be resolved (details in #242)."}}
{"actor":{"display_login":"aantron"}}