{"action":"opened","issue":{"url":"https://api.github.com/repos/biometry/rLPJGUESS/issues/43","repository_url":"https://api.github.com/repos/biometry/rLPJGUESS","labels_url":"https://api.github.com/repos/biometry/rLPJGUESS/issues/43/labels{/name}","comments_url":"https://api.github.com/repos/biometry/rLPJGUESS/issues/43/comments","events_url":"https://api.github.com/repos/biometry/rLPJGUESS/issues/43/events","html_url":"https://github.com/biometry/rLPJGUESS/issues/43","id":336269514,"node_id":"MDU6SXNzdWUzMzYyNjk1MTQ=","number":43,"title":"help files in general","user":{"login":"florianhartig","id":5457753,"node_id":"MDQ6VXNlcjU0NTc3NTM=","avatar_url":"https://avatars0.githubusercontent.com/u/5457753?v=4","gravatar_id":"","url":"https://api.github.com/users/florianhartig","html_url":"https://github.com/florianhartig","followers_url":"https://api.github.com/users/florianhartig/followers","following_url":"https://api.github.com/users/florianhartig/following{/other_user}","gists_url":"https://api.github.com/users/florianhartig/gists{/gist_id}","starred_url":"https://api.github.com/users/florianhartig/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/florianhartig/subscriptions","organizations_url":"https://api.github.com/users/florianhartig/orgs","repos_url":"https://api.github.com/users/florianhartig/repos","events_url":"https://api.github.com/users/florianhartig/events{/privacy}","received_events_url":"https://api.github.com/users/florianhartig/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-06-27T15:04:20Z","updated_at":"2018-06-27T15:04:20Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"a comment about the help - when I was writing the unit tests now, I realized that the help does not do a good job in showing the context in which functions are being used. \r\n\r\nTake as example plotLPJData - this function requires running getLPJData first, but this is nowhere documented, it just says that the input variable x is an LPJData object.\r\n\r\nA good help should have \r\n\r\n- a link to getLPJData in the help of x\r\n- a link to getLPJData with the @seealso tag\r\n- a shared help file that shows both functions in context, see also comment in https://github.com/biometry/rLPJGUESS/issues/39\r\n\r\nsee, for example, ?DHARMa::plot.DHARMa\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n"}}
{"actor":{"display_login":"florianhartig"}}