{"action":"created","issue":{"url":"https://api.github.com/repos/gaborcsardi/argufy/issues/21","labels_url":"https://api.github.com/repos/gaborcsardi/argufy/issues/21/labels{/name}","comments_url":"https://api.github.com/repos/gaborcsardi/argufy/issues/21/comments","events_url":"https://api.github.com/repos/gaborcsardi/argufy/issues/21/events","html_url":"https://github.com/gaborcsardi/argufy/issues/21","id":119560873,"number":21,"title":"Use comments instead","user":{"login":"gaborcsardi","id":660288,"avatar_url":"https://avatars.githubusercontent.com/u/660288?v=3","gravatar_id":"","url":"https://api.github.com/users/gaborcsardi","html_url":"https://github.com/gaborcsardi","followers_url":"https://api.github.com/users/gaborcsardi/followers","following_url":"https://api.github.com/users/gaborcsardi/following{/other_user}","gists_url":"https://api.github.com/users/gaborcsardi/gists{/gist_id}","starred_url":"https://api.github.com/users/gaborcsardi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gaborcsardi/subscriptions","organizations_url":"https://api.github.com/users/gaborcsardi/orgs","repos_url":"https://api.github.com/users/gaborcsardi/repos","events_url":"https://api.github.com/users/gaborcsardi/events{/privacy}","received_events_url":"https://api.github.com/users/gaborcsardi/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":8,"created_at":"2015-11-30T19:19:56Z","updated_at":"2016-01-26T16:47:57Z","closed_at":null,"body":"@jimhester As it happens  I am not using `argufy` in my own projects, I am not sure why. I am just somehow uncomfortable with it, maybe because I am not happy with the syntax. It seems heavy.\r\n\r\nSo, how about trying to use comments instead? :) I am serious.\r\n\r\nE.g. something like\r\n\r\n```r\r\nprefix <-function(\r\n    str,            #' as.character\r\n    len = 3         #' is.numeric\r\n) {\r\n  substring(x, 1, y)\r\n})\r\n```\r\n\r\nThen you could just run `argufy_package` on it. "},"comment":{"url":"https://api.github.com/repos/gaborcsardi/argufy/issues/comments/175109771","html_url":"https://github.com/gaborcsardi/argufy/issues/21#issuecomment-175109771","issue_url":"https://api.github.com/repos/gaborcsardi/argufy/issues/21","id":175109771,"user":{"login":"lawremi","id":158190,"avatar_url":"https://avatars.githubusercontent.com/u/158190?v=3","gravatar_id":"","url":"https://api.github.com/users/lawremi","html_url":"https://github.com/lawremi","followers_url":"https://api.github.com/users/lawremi/followers","following_url":"https://api.github.com/users/lawremi/following{/other_user}","gists_url":"https://api.github.com/users/lawremi/gists{/gist_id}","starred_url":"https://api.github.com/users/lawremi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lawremi/subscriptions","organizations_url":"https://api.github.com/users/lawremi/orgs","repos_url":"https://api.github.com/users/lawremi/repos","events_url":"https://api.github.com/users/lawremi/events{/privacy}","received_events_url":"https://api.github.com/users/lawremi/received_events","type":"User","site_admin":false},"created_at":"2016-01-26T16:47:57Z","updated_at":"2016-01-26T16:47:57Z","body":"It's important not to forget the semantic advantages. Even if the syntax ends up being equivalent to `stopifnot()`, the assertions are formally declared, and there is no need to rely on heuristic static analysis to derive them. \r\n\r\nThere needs to be a general and extensible framework for processing R packages. I have discussed this at length with @gmbecker. I'm not that familiar with roxygen, but it might well serve as a prototyping platform for these ideas. Roxygen has worked well so far by treating the .R file as the source for everything. If we want the R code itself to be generated/modified, I can think of two possibilities:\r\n\r\n1. Create an entirely separate source document, not necessarily in the `R` directory, and the system generates one or more R files in the `R` directory,\r\n2. Generate the R code at runtime, perhaps based on code-rewriting rules that were generated by roxygen.\r\n\r\nI like the second, just because it does not change the location of the source, nor produce a mash-up of hand-written and generated source files. The runtime code patching could be implemented by some package, not necessarily roxygen2, but the generation of the rules would happen through a \"roclet\". \r\n\r\nI like your syntax:\r\n```\r\n#' @param x [character(1)] First argument...\r\n```"}}