{ "id": "83539", "key": "TIMOB-10240", "fields": { "issuetype": { "id": "2", "description": "A new feature of the product, which has yet to be developed.", "name": "New Feature", "subtask": false }, "project": { "id": "10153", "key": "TIMOB", "name": "Titanium SDK/CLI", "projectCategory": { "id": "10100", "description": "Titanium and related SDKs used in application development", "name": "Client" } }, "fixVersions": [ { "id": "14064", "description": "Sprint 2012-17 Core", "name": "Sprint 2012-17 Core", "archived": true, "released": true, "releaseDate": "2012-08-27" }, { "id": "13505", "description": "Release 3.0.0", "name": "Release 3.0.0", "archived": true, "released": true, "releaseDate": "2012-12-14" } ], "resolution": { "id": "1", "description": "A fix for this issue is checked into the tree and tested.", "name": "Fixed" }, "resolutiondate": "2012-08-24T10:53:14.000+0000", "created": "2011-12-09T13:16:35.000+0000", "priority": { "name": "Medium", "id": "3" }, "labels": [], "versions": [ { "id": "13505", "description": "Release 3.0.0", "name": "Release 3.0.0", "archived": true, "released": true, "releaseDate": "2012-12-14" } ], "issuelinks": [ { "id": "14992", "type": { "id": "10011", "name": "Includes", "inward": "is included by", "outward": "includes" }, "inwardIssue": { "id": "85518", "key": "TIMOB-7421", "fields": { "summary": "Tooling: As a Ti documentation writer, I would like to have access to enhanced TDoc tools", "status": { "description": "The issue is open and ready for the assignee to start work on it.", "name": "Open", "id": "1", "statusCategory": { "id": 2, "key": "new", "colorName": "blue-gray", "name": "To Do" } }, "priority": { "name": "High", "id": "2" }, "issuetype": { "id": "7", "description": "gh.issue.story.desc", "name": "Story", "subtask": false } } } }, { "id": "19500", "type": { "id": "10003", "name": "Relates", "inward": "relates to", "outward": "relates to" }, "outwardIssue": { "id": "83569", "key": "TIMOB-10241", "fields": { "summary": "APIDoc: docgen.py should mark creator method as deprecated when the associated object is deprecated", "status": { "description": "The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.", "name": "Closed", "id": "6", "statusCategory": { "id": 3, "key": "done", "colorName": "green", "name": "Done" } }, "priority": { "name": "Medium", "id": "3" }, "issuetype": { "id": "1", "description": "A problem which impairs or prevents the functions of the product.", "name": "Bug", "subtask": false } } } } ], "assignee": { "name": "billdawson", "key": "billdawson", "displayName": "Bill Dawson", "active": true, "timeZone": "Europe/Berlin" }, "updated": "2012-11-26T21:46:57.000+0000", "status": { "description": "The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.", "name": "Closed", "id": "6", "statusCategory": { "id": 3, "key": "done", "colorName": "green", "name": "Done" } }, "components": [ { "id": "10207", "name": "Tooling" } ], "description": "It would be nice if the deprecation annotation included a free-text field where we could describe what to use instead. The alternative is to reuse the summary text, possibly removing the only documentation describing the item.\r\n\r\nThis proposal is to add a field, which for the sake of argument I'll call notes, like this:\r\n\r\n{code}\r\ndeprecated:\r\n since: 1.8.0\r\n removed: 1.9.0\r\n notes: Use instead.\r\n{code}\r\n\r\nFor summary tables, the deprecated.notes field could be used in place of the summary, so\r\nusers would see something like:\r\n\r\nbq. DEPRECATED Use instead.\r\n\r\nFor the detail page, the note would show up as part of the deprecation warning, and \r\nthe usual summary would appear:\r\n\r\nbq. Deprecated since 1.8.0, removed in 1.9.0. Use instead.\r\nbq.\r\nbq. Summary\r\n\r\nbq. A view which automatically renders as an octagon.\r\n", "attachment": [], "flagged": false, "summary": "APIDoc: Add \"notes\" or \"see\" field to \"deprecated\" annotation", "creator": { "name": "aevans", "key": "aevans", "displayName": "Arthur Evans", "active": true, "timeZone": "America/Los_Angeles" }, "subtasks": [], "reporter": { "name": "aevans", "key": "aevans", "displayName": "Arthur Evans", "active": true, "timeZone": "America/Los_Angeles" }, "environment": null, "comment": { "comments": [ { "id": "215047", "author": { "name": "billdawson", "key": "billdawson", "displayName": "Bill Dawson", "active": true, "timeZone": "Europe/Berlin" }, "body": "I'll start this by updating validate.py, the spec, and the htmlgenerator (though we don't really use that, it's nice to have.) For the jsduck changes probably we should have a separate ticket, since it'll start getting \"weird\" if we have multiple people making PRs for the same ticket.", "updateAuthor": { "name": "billdawson", "key": "billdawson", "displayName": "Bill Dawson", "active": true, "timeZone": "Europe/Berlin" }, "created": "2012-08-17T17:18:20.000+0000", "updated": "2012-08-17T17:18:20.000+0000" }, { "id": "215505", "author": { "name": "billdawson", "key": "billdawson", "displayName": "Bill Dawson", "active": true, "timeZone": "Europe/Berlin" }, "body": "h3. Testing Notes\r\n\r\n* Open apidoc/Titanium/Network/TCPSocket.yml in an editor.\r\n\r\n* In the type's {{deprecated}} block, add:\r\n\r\n{code}\r\n notes: Use instead.\r\n{code}\r\n\r\n* Save the file.\r\n\r\n* Run {{python apidoc/validate.py -e -s simple}} for a sanity check. (It has been updated for this.)\r\n\r\n* Run {{python apidoc/docgen.py}}.\r\n\r\n* When it's finished, open dist/apidoc/index.html in a web browser.\r\n\r\n* Navigate to the Titanium.Network.TCPSocket documentation page.\r\n\r\n* Make sure the deprecation information includes the \"Use Titanium.Network.Socket.TCP instead\" comment, and that \"Titanium.Network.Socket.TCP\" is a link that, when clicked, properly goes to the Titanium.Network.Socket.TCP documentation page.", "updateAuthor": { "name": "billdawson", "key": "billdawson", "displayName": "Bill Dawson", "active": true, "timeZone": "Europe/Berlin" }, "created": "2012-08-21T17:35:03.000+0000", "updated": "2012-08-21T17:35:03.000+0000" }, { "id": "215506", "author": { "name": "billdawson", "key": "billdawson", "displayName": "Bill Dawson", "active": true, "timeZone": "Europe/Berlin" }, "body": "Pull request ready:\r\n\r\nhttps://github.com/appcelerator/titanium_mobile/pull/2803", "updateAuthor": { "name": "billdawson", "key": "billdawson", "displayName": "Bill Dawson", "active": true, "timeZone": "Europe/Berlin" }, "created": "2012-08-21T17:41:27.000+0000", "updated": "2012-08-21T17:41:27.000+0000" }, { "id": "228525", "author": { "name": "nhuynh", "key": "nhuynh", "displayName": "Natalie Huynh", "active": true, "timeZone": "America/Los_Angeles" }, "body": "Tested with 3.0.0.v20121121161553, do not need to add notes, it is already added so just run validation", "updateAuthor": { "name": "nhuynh", "key": "nhuynh", "displayName": "Natalie Huynh", "active": true, "timeZone": "America/Los_Angeles" }, "created": "2012-11-26T21:46:57.000+0000", "updated": "2012-11-26T21:46:57.000+0000" } ], "maxResults": 4, "total": 4, "startAt": 0 } } }