{"action":"created","issue":{"url":"https://api.github.com/repos/SpriteLink/NIPAP/issues/750","labels_url":"https://api.github.com/repos/SpriteLink/NIPAP/issues/750/labels{/name}","comments_url":"https://api.github.com/repos/SpriteLink/NIPAP/issues/750/comments","events_url":"https://api.github.com/repos/SpriteLink/NIPAP/issues/750/events","html_url":"https://github.com/SpriteLink/NIPAP/issues/750","id":71223376,"number":750,"title":"API doc incorrectly says edit_prefix takes \"spec\" argument","user":{"login":"toreanderson","id":4557060,"avatar_url":"https://avatars.githubusercontent.com/u/4557060?v=3","gravatar_id":"","url":"https://api.github.com/users/toreanderson","html_url":"https://github.com/toreanderson","followers_url":"https://api.github.com/users/toreanderson/followers","following_url":"https://api.github.com/users/toreanderson/following{/other_user}","gists_url":"https://api.github.com/users/toreanderson/gists{/gist_id}","starred_url":"https://api.github.com/users/toreanderson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/toreanderson/subscriptions","organizations_url":"https://api.github.com/users/toreanderson/orgs","repos_url":"https://api.github.com/users/toreanderson/repos","events_url":"https://api.github.com/users/toreanderson/events{/privacy}","received_events_url":"https://api.github.com/users/toreanderson/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-04-27T08:52:32Z","updated_at":"2015-04-28T08:34:20Z","closed_at":null,"body":"From http://nipap-plajjan.readthedocs.org/en/latest/nipap.html#nipap.backend.Nipap.edit_prefix:\r\n```\r\nspec [prefix_spec]\r\n    Specifies the prefix to edit.\r\n```\r\nThat doesn't work, however. This should probably read `prefix [prefix_spec]` instead (which does work).\r\n\r\nFor what it's worth I see that the `spec` attribute is mentioned for other API calls too, so maybe the same mistake is made elsewhere."},"comment":{"url":"https://api.github.com/repos/SpriteLink/NIPAP/issues/comments/96975607","html_url":"https://github.com/SpriteLink/NIPAP/issues/750#issuecomment-96975607","issue_url":"https://api.github.com/repos/SpriteLink/NIPAP/issues/750","id":96975607,"user":{"login":"plajjan","id":841628,"avatar_url":"https://avatars.githubusercontent.com/u/841628?v=3","gravatar_id":"","url":"https://api.github.com/users/plajjan","html_url":"https://github.com/plajjan","followers_url":"https://api.github.com/users/plajjan/followers","following_url":"https://api.github.com/users/plajjan/following{/other_user}","gists_url":"https://api.github.com/users/plajjan/gists{/gist_id}","starred_url":"https://api.github.com/users/plajjan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/plajjan/subscriptions","organizations_url":"https://api.github.com/users/plajjan/orgs","repos_url":"https://api.github.com/users/plajjan/repos","events_url":"https://api.github.com/users/plajjan/events{/privacy}","received_events_url":"https://api.github.com/users/plajjan/received_events","type":"User","site_admin":false},"created_at":"2015-04-28T08:34:20Z","updated_at":"2015-04-28T08:34:20Z","body":"\nAh yes. Technically, the docs are correct. You are looking at the docs for the backend module and its argument is called spec. However, we have the XML-RPC wrapper around the backend to expose its methods over the XML-RPC API and that method  takes an argument called 'prefix'. I believe if you look at that methods docs you will find that the argument is called prefix. \n\nSince we want to avoid duplication we have tried to put as much documentation in the backend module so that readers should not have to look around in a lot of places to understand the design. This is an example where the reader would have to look around in multiple places and there is no reason for it. I suggest we simply rename the argument in one of the functions so that they are called the same.\n\n> On 27 Apr 2015, at 09:52, Tore Anderson <notifications@github.com> wrote:\n> \n> From http://nipap-plajjan.readthedocs.org/en/latest/nipap.html#nipap.backend.Nipap.edit_prefix:\n> \n> spec [prefix_spec]\n>     Specifies the prefix to edit.\n> That doesn't work, however. This should probably read prefix [prefix_spec] instead (which does work).\n> \n> For what it's worth I see that the spec attribute is mentioned for other API calls too, so maybe the same mistake is made elsewhere.\n> \n> —\n> Reply to this email directly or view it on GitHub.\n> \n"}}