{"action":"created","issue":{"url":"https://api.github.com/repos/PecanProject/pecan/issues/375","labels_url":"https://api.github.com/repos/PecanProject/pecan/issues/375/labels{/name}","comments_url":"https://api.github.com/repos/PecanProject/pecan/issues/375/comments","events_url":"https://api.github.com/repos/PecanProject/pecan/issues/375/events","html_url":"https://github.com/PecanProject/pecan/pull/375","id":60602044,"number":375,"title":"update documentation with build.sh --check","user":{"login":"dlebauer","id":464871,"avatar_url":"https://avatars.githubusercontent.com/u/464871?v=3","gravatar_id":"","url":"https://api.github.com/users/dlebauer","html_url":"https://github.com/dlebauer","followers_url":"https://api.github.com/users/dlebauer/followers","following_url":"https://api.github.com/users/dlebauer/following{/other_user}","gists_url":"https://api.github.com/users/dlebauer/gists{/gist_id}","starred_url":"https://api.github.com/users/dlebauer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dlebauer/subscriptions","organizations_url":"https://api.github.com/users/dlebauer/orgs","repos_url":"https://api.github.com/users/dlebauer/repos","events_url":"https://api.github.com/users/dlebauer/events{/privacy}","received_events_url":"https://api.github.com/users/dlebauer/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/PecanProject/pecan/labels/in%20progress","name":"in progress","color":"ededed"}],"state":"open","locked":false,"assignee":{"login":"robkooper","id":1580696,"avatar_url":"https://avatars.githubusercontent.com/u/1580696?v=3","gravatar_id":"","url":"https://api.github.com/users/robkooper","html_url":"https://github.com/robkooper","followers_url":"https://api.github.com/users/robkooper/followers","following_url":"https://api.github.com/users/robkooper/following{/other_user}","gists_url":"https://api.github.com/users/robkooper/gists{/gist_id}","starred_url":"https://api.github.com/users/robkooper/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/robkooper/subscriptions","organizations_url":"https://api.github.com/users/robkooper/orgs","repos_url":"https://api.github.com/users/robkooper/repos","events_url":"https://api.github.com/users/robkooper/events{/privacy}","received_events_url":"https://api.github.com/users/robkooper/received_events","type":"User","site_admin":false},"milestone":null,"comments":2,"created_at":"2015-03-11T02:46:05Z","updated_at":"2015-03-13T21:01:46Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/PecanProject/pecan/pulls/375","html_url":"https://github.com/PecanProject/pecan/pull/375","diff_url":"https://github.com/PecanProject/pecan/pull/375.diff","patch_url":"https://github.com/PecanProject/pecan/pull/375.patch"},"body":"This will ensure that any invalid roxygen code will be caught at time of writing (and will not have to wait until the next time someone updates documentation)"},"comment":{"url":"https://api.github.com/repos/PecanProject/pecan/issues/comments/79392415","html_url":"https://github.com/PecanProject/pecan/pull/375#issuecomment-79392415","issue_url":"https://api.github.com/repos/PecanProject/pecan/issues/375","id":79392415,"user":{"login":"dlebauer","id":464871,"avatar_url":"https://avatars.githubusercontent.com/u/464871?v=3","gravatar_id":"","url":"https://api.github.com/users/dlebauer","html_url":"https://github.com/dlebauer","followers_url":"https://api.github.com/users/dlebauer/followers","following_url":"https://api.github.com/users/dlebauer/following{/other_user}","gists_url":"https://api.github.com/users/dlebauer/gists{/gist_id}","starred_url":"https://api.github.com/users/dlebauer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dlebauer/subscriptions","organizations_url":"https://api.github.com/users/dlebauer/orgs","repos_url":"https://api.github.com/users/dlebauer/repos","events_url":"https://api.github.com/users/dlebauer/events{/privacy}","received_events_url":"https://api.github.com/users/dlebauer/received_events","type":"User","site_admin":false},"created_at":"2015-03-13T21:01:46Z","updated_at":"2015-03-13T21:01:46Z","body":"@robkooper \r\n\r\n* The issue is that I have had to clean up invalid documentation more than once.\r\n* My proposed fix is that the documentation needs to be generated prior to checking, or else invalid documentation will not be caught\r\n * this will ensure that any new documentation is valid before the checks run. \r\n* The goal here is _not_ to actually update the documentation, \r\n\r\nWe could update Jenkins to use `build.sh --document --check` and tell people to do this for themselves. But we don't want everyone updating (and especially not committing) their documentation every time they test.\r\n\r\nOne option would be that the `--check` flag is only for testing, and would not auto generate documentation for the user's local copy of the repository or install packages.\r\n\r\nFor example, if the `check = YES`, the whole process could be done in the `/tmp` directory.\r\n\r\n```\r\nif check\r\n  cp -R pecan /tmp/pecan\r\n  cd /tmp/pecan\r\n ..... continue with the rest of script\r\n rm -rf /tmp/pecan\r\n```\r\n\r\nor \r\n\r\n```\r\nif check \r\n  git checkout -b tmp\r\n  ... continue with script\r\n\r\n  git checkout - # return to prev. branch\r\n  git branch -d tmp\r\n```\r\n\r\n"}}