{"action":"created","issue":{"url":"https://api.github.com/repos/acoomans/flask-autodoc/issues/14","labels_url":"https://api.github.com/repos/acoomans/flask-autodoc/issues/14/labels{/name}","comments_url":"https://api.github.com/repos/acoomans/flask-autodoc/issues/14/comments","events_url":"https://api.github.com/repos/acoomans/flask-autodoc/issues/14/events","html_url":"https://github.com/acoomans/flask-autodoc/pull/14","id":54155277,"number":14,"title":"Custom Function Properties","user":{"login":"BallisticBuddha","id":711464,"avatar_url":"https://avatars.githubusercontent.com/u/711464?v=3","gravatar_id":"","url":"https://api.github.com/users/BallisticBuddha","html_url":"https://github.com/BallisticBuddha","followers_url":"https://api.github.com/users/BallisticBuddha/followers","following_url":"https://api.github.com/users/BallisticBuddha/following{/other_user}","gists_url":"https://api.github.com/users/BallisticBuddha/gists{/gist_id}","starred_url":"https://api.github.com/users/BallisticBuddha/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/BallisticBuddha/subscriptions","organizations_url":"https://api.github.com/users/BallisticBuddha/orgs","repos_url":"https://api.github.com/users/BallisticBuddha/repos","events_url":"https://api.github.com/users/BallisticBuddha/events{/privacy}","received_events_url":"https://api.github.com/users/BallisticBuddha/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/acoomans/flask-autodoc/labels/enhancement","name":"enhancement","color":"84b6eb"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":6,"created_at":"2015-01-13T06:26:23Z","updated_at":"2015-09-15T15:03:22Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/acoomans/flask-autodoc/pulls/14","html_url":"https://github.com/acoomans/flask-autodoc/pull/14","diff_url":"https://github.com/acoomans/flask-autodoc/pull/14.diff","patch_url":"https://github.com/acoomans/flask-autodoc/pull/14.patch"},"body":"Added variable args to the doc decorator that add custom variables to a route's documentation.\r\n\r\nThese variables are passed into the documentation that is generated and can be used in the template to have more customized and structured data (e.g. query string parameters, post form data, expected content types, etc.) without having to put everything in the docstring, making those properties easier to deal with when working with a template.\r\n\r\nThe default template has also been modified to display these custom properties in a similar fashion as the default ones. However, the data is currently only displayed as raw string conversions from python, with no formatting changes.\r\n\r\nAdditionally, some existing function properties can be overridden by specifying them in the decorator.\r\nI hardcoded a variable in autodoc that defines which properties cannot be overridden, these are currently 'rule' and 'endpoint'.\r\n"},"comment":{"url":"https://api.github.com/repos/acoomans/flask-autodoc/issues/comments/140421972","html_url":"https://github.com/acoomans/flask-autodoc/pull/14#issuecomment-140421972","issue_url":"https://api.github.com/repos/acoomans/flask-autodoc/issues/14","id":140421972,"user":{"login":"lukeyeager","id":687269,"avatar_url":"https://avatars.githubusercontent.com/u/687269?v=3","gravatar_id":"","url":"https://api.github.com/users/lukeyeager","html_url":"https://github.com/lukeyeager","followers_url":"https://api.github.com/users/lukeyeager/followers","following_url":"https://api.github.com/users/lukeyeager/following{/other_user}","gists_url":"https://api.github.com/users/lukeyeager/gists{/gist_id}","starred_url":"https://api.github.com/users/lukeyeager/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lukeyeager/subscriptions","organizations_url":"https://api.github.com/users/lukeyeager/orgs","repos_url":"https://api.github.com/users/lukeyeager/repos","events_url":"https://api.github.com/users/lukeyeager/events{/privacy}","received_events_url":"https://api.github.com/users/lukeyeager/received_events","type":"User","site_admin":false},"created_at":"2015-09-15T15:03:22Z","updated_at":"2015-09-15T15:03:22Z","body":"1) Rebasing\r\n\r\n> I had to re-author the commit, which now has a commit date of today, rather than in January when I actually wrote all this code. I was trying to avoid this, as I hate falsifying commit dates, but if you really need the commit history to be as pristine as possible, I am willing to get over this pet peeve of mine.\r\n\r\nAh ok, I didn't realize you cared about that. You're the first I've encountered with that particular pet peeve. Thanks for putting up with mine about commit history :stuck_out_tongue_winking_eye:\r\n\r\n2) Testing\r\n\r\n>I don't know if you ever tried to make a test case that tests to make sure that the location line is actually put into the generated HTML document, but if you ever do, you will likely run into this madness as well.\r\n\r\nAh, no I didn't test it in the HTML. [This is as far as I got](https://github.com/lukeyeager/flask-autodoc/blob/66506cf0376547d5a548ff8bc9bebb805b30387e/tests/test_autodoc.py#L207) w.r.t. testing. (NOTE: I'm waiting to merge this before merging that in #19)"}}