{"action":"closed","issue":{"url":"https://api.github.com/repos/abathur/ldmud-doc/issues/10","repository_url":"https://api.github.com/repos/abathur/ldmud-doc","labels_url":"https://api.github.com/repos/abathur/ldmud-doc/issues/10/labels{/name}","comments_url":"https://api.github.com/repos/abathur/ldmud-doc/issues/10/comments","events_url":"https://api.github.com/repos/abathur/ldmud-doc/issues/10/events","html_url":"https://github.com/abathur/ldmud-doc/issues/10","id":110863936,"number":10,"title":"how document/code \"status\" is handled","user":{"login":"abathur","id":2548365,"avatar_url":"https://avatars.githubusercontent.com/u/2548365?v=3","gravatar_id":"","url":"https://api.github.com/users/abathur","html_url":"https://github.com/abathur","followers_url":"https://api.github.com/users/abathur/followers","following_url":"https://api.github.com/users/abathur/following{/other_user}","gists_url":"https://api.github.com/users/abathur/gists{/gist_id}","starred_url":"https://api.github.com/users/abathur/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/abathur/subscriptions","organizations_url":"https://api.github.com/users/abathur/orgs","repos_url":"https://api.github.com/users/abathur/repos","events_url":"https://api.github.com/users/abathur/events{/privacy}","received_events_url":"https://api.github.com/users/abathur/received_events","type":"User","site_admin":false},"labels":[{"id":271297453,"url":"https://api.github.com/repos/abathur/ldmud-doc/labels/organization","name":"organization","color":"bfd4f2","default":false},{"id":271297864,"url":"https://api.github.com/repos/abathur/ldmud-doc/labels/semantics","name":"semantics","color":"0052cc","default":false},{"id":287070624,"url":"https://api.github.com/repos/abathur/ldmud-doc/labels/undecided","name":"undecided","color":"e11d21","default":false}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2015-10-11T15:42:23Z","updated_at":"2016-12-03T20:25:26Z","closed_at":"2016-12-03T20:25:26Z","body":"A number of existing docs use the first line to declare a status of some sort (generally: optional, preliminary/experimental, and deprecated/obsolete/removed). Additionally, everything in the \"obsolete\" directory has a sort of implicit status which is hard to untangle from the OBSOLETE line. Going over these docs has exposed some weirdness and contradiction to me that suggests we should maybe rethink how status is conveyed.\n\nHere's a short list of some of the smells/weirdness that make me think there are underlying conceptual problems:\n- As I _read_ the existence of OBSOLETE, DEPRECATED and REMOVED status lines, I assume obsolete means something that hasn't yet been officially deprecated, but shouldn't be used (see efun/md5 for an example). The README doc states that the obsolete directory contains \"docs for features removed from the driver,\" however, which implies that OBSOLETE and REMOVED could also be equivalent.\n- There's a copy of parse_command in obsolete/ and another in efun/, because the function is \"removed\" in compat mode only. The documents are near-identical, but ripe for divergence. The obsolete copy doesn't have an OPTIONAL status, but the one in efun does. The copy in \"obsolete\" breaks all conventions by putting \"Compat mode\" and a blank line at the top of its synopsis section. What does this mean? It implies this synopsis is FOR compat mode, but the history section of both documents state it is REMOVED from compat mode. I could also interpret as meaning older versions which supported this function in compat mode used these function forms, but the forms are equivalent between both copies.\n- Anything in /obsolete/\\* which is marked with an OPTIONAL status has _really_ murky semantics. The README states that obsolete contains \"docs for features removed from the driver\", but the alist efuns (insert_alist, intersect_alist, order_alist) all have an OPTIONAL status. These contradictions make it very unclear whether they were optional in their past life and are now removed, or whether they aren't _technically_ removed and have instead just been made optional (and might be better thought of as deprecated?)\n- In the context of a generated documentation system with conveniences like an index, multiple slightly-differing copies of the same document can result in an index with multiple copies of the same function/concept with no clear way to tell which is which (without reading URLs).\n\nI'll follow up with my first take on what we could do with these (eventually), but I'm also hesitant to guide the discussion too heavily at the start, since I realize I may not be able to see the forest for the trees at the moment. \n\nThis issue is related to some others:\n- what statuses do we use/care about and how do we define them? #11\n- how should status be presented visually (in HTML and plaintext output) #12 \n"}}
{"actor":{"display_login":"abathur"}}