{"action":"created","issue":{"url":"https://api.github.com/repos/arduino/Arduino/issues/2676","labels_url":"https://api.github.com/repos/arduino/Arduino/issues/2676/labels{/name}","comments_url":"https://api.github.com/repos/arduino/Arduino/issues/2676/comments","events_url":"https://api.github.com/repos/arduino/Arduino/issues/2676/events","html_url":"https://github.com/arduino/Arduino/issues/2676","id":58501962,"number":2676,"title":"attachInterrupt page should document & recommend using digitalPinToInterrupt()","user":{"login":"PaulStoffregen","id":965463,"avatar_url":"https://avatars.githubusercontent.com/u/965463?v=3","gravatar_id":"","url":"https://api.github.com/users/PaulStoffregen","html_url":"https://github.com/PaulStoffregen","followers_url":"https://api.github.com/users/PaulStoffregen/followers","following_url":"https://api.github.com/users/PaulStoffregen/following{/other_user}","gists_url":"https://api.github.com/users/PaulStoffregen/gists{/gist_id}","starred_url":"https://api.github.com/users/PaulStoffregen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/PaulStoffregen/subscriptions","organizations_url":"https://api.github.com/users/PaulStoffregen/orgs","repos_url":"https://api.github.com/users/PaulStoffregen/repos","events_url":"https://api.github.com/users/PaulStoffregen/events{/privacy}","received_events_url":"https://api.github.com/users/PaulStoffregen/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/arduino/Arduino/labels/Component:%20Documentation","name":"Component: Documentation","color":"009800"},{"url":"https://api.github.com/repos/arduino/Arduino/labels/Waiting%20for%20feedback","name":"Waiting for feedback","color":"fef2c0"}],"state":"open","locked":false,"assignee":{"login":"agdl","id":2743774,"avatar_url":"https://avatars.githubusercontent.com/u/2743774?v=3","gravatar_id":"","url":"https://api.github.com/users/agdl","html_url":"https://github.com/agdl","followers_url":"https://api.github.com/users/agdl/followers","following_url":"https://api.github.com/users/agdl/following{/other_user}","gists_url":"https://api.github.com/users/agdl/gists{/gist_id}","starred_url":"https://api.github.com/users/agdl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/agdl/subscriptions","organizations_url":"https://api.github.com/users/agdl/orgs","repos_url":"https://api.github.com/users/agdl/repos","events_url":"https://api.github.com/users/agdl/events{/privacy}","received_events_url":"https://api.github.com/users/agdl/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/arduino/Arduino/milestones/15","html_url":"https://github.com/arduino/Arduino/milestones/Release%201.6.6","labels_url":"https://api.github.com/repos/arduino/Arduino/milestones/15/labels","id":1158070,"number":15,"title":"Release 1.6.6","description":"","creator":{"login":"ffissore","id":510465,"avatar_url":"https://avatars.githubusercontent.com/u/510465?v=3","gravatar_id":"","url":"https://api.github.com/users/ffissore","html_url":"https://github.com/ffissore","followers_url":"https://api.github.com/users/ffissore/followers","following_url":"https://api.github.com/users/ffissore/following{/other_user}","gists_url":"https://api.github.com/users/ffissore/gists{/gist_id}","starred_url":"https://api.github.com/users/ffissore/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ffissore/subscriptions","organizations_url":"https://api.github.com/users/ffissore/orgs","repos_url":"https://api.github.com/users/ffissore/repos","events_url":"https://api.github.com/users/ffissore/events{/privacy}","received_events_url":"https://api.github.com/users/ffissore/received_events","type":"User","site_admin":false},"open_issues":59,"closed_issues":484,"state":"open","created_at":"2015-06-10T07:48:32Z","updated_at":"2015-09-08T11:33:51Z","due_on":null,"closed_at":null},"comments":8,"created_at":"2015-02-22T13:04:03Z","updated_at":"2015-09-08T12:30:08Z","closed_at":null,"body":"This page about attachInterrupt:\r\n\r\nhttp://arduino.cc/en/Reference/AttachInterrupt\r\n\r\nshould document the new digitalPinToInterrupt() function and show an example, such as:\r\n\r\n    attachInterrupt(digitalPinToInterrupt(pin), ISR, mode);"},"comment":{"url":"https://api.github.com/repos/arduino/Arduino/issues/comments/138544739","html_url":"https://github.com/arduino/Arduino/issues/2676#issuecomment-138544739","issue_url":"https://api.github.com/repos/arduino/Arduino/issues/2676","id":138544739,"user":{"login":"PaulStoffregen","id":965463,"avatar_url":"https://avatars.githubusercontent.com/u/965463?v=3","gravatar_id":"","url":"https://api.github.com/users/PaulStoffregen","html_url":"https://github.com/PaulStoffregen","followers_url":"https://api.github.com/users/PaulStoffregen/followers","following_url":"https://api.github.com/users/PaulStoffregen/following{/other_user}","gists_url":"https://api.github.com/users/PaulStoffregen/gists{/gist_id}","starred_url":"https://api.github.com/users/PaulStoffregen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/PaulStoffregen/subscriptions","organizations_url":"https://api.github.com/users/PaulStoffregen/orgs","repos_url":"https://api.github.com/users/PaulStoffregen/repos","events_url":"https://api.github.com/users/PaulStoffregen/events{/privacy}","received_events_url":"https://api.github.com/users/PaulStoffregen/received_events","type":"User","site_admin":false},"created_at":"2015-09-08T12:30:08Z","updated_at":"2015-09-08T12:30:08Z","body":"Please make these 4 edits.  I reopened this issue and supplied exact text, to make this as easy as possible for you.\r\n\r\nI hope you can see how the small edit which adds digitalPinToInterrupt(), but leaves the old, no-longer-recommended approach prominently featured at the top of the page and still used in the examples is bad form.  Yes, it's quicker and easier to make only tiny edits to these old documentation pages.  But the result is poor documentation which still prominently features the old, bad way of writing code.\r\n\r\nAs you edit more Arduino documentation, I hope you will begin to consider the writing style.  Simply adding small notes tends to result in pages that are unclear about best practices.  I know this is a lot to ask, but please try to think of the effect this sort of documentation has for real Arduino users.  Especially when there are recommended ways to write code, Arduino's documentation should always explain the recommended way first.  All of the examples should be updated to the best way.  Older, poor ways should not remain in any examples.  Not-recommended approaches should always appear at the end of the page, as footnotes only for completeness of documentation.\r\n\r\nYes, this is a lot more work, but it is very important to do a good quality job on Arduino's documentation."}}