{"action":"created","issue":{"url":"https://api.github.com/repos/perl6/doc/issues/776","repository_url":"https://api.github.com/repos/perl6/doc","labels_url":"https://api.github.com/repos/perl6/doc/issues/776/labels{/name}","comments_url":"https://api.github.com/repos/perl6/doc/issues/776/comments","events_url":"https://api.github.com/repos/perl6/doc/issues/776/events","html_url":"https://github.com/perl6/doc/issues/776","id":168208411,"number":776,"title":"Single style for output of examples","user":{"login":"Altai-man","id":5764435,"avatar_url":"https://avatars.githubusercontent.com/u/5764435?v=3","gravatar_id":"","url":"https://api.github.com/users/Altai-man","html_url":"https://github.com/Altai-man","followers_url":"https://api.github.com/users/Altai-man/followers","following_url":"https://api.github.com/users/Altai-man/following{/other_user}","gists_url":"https://api.github.com/users/Altai-man/gists{/gist_id}","starred_url":"https://api.github.com/users/Altai-man/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Altai-man/subscriptions","organizations_url":"https://api.github.com/users/Altai-man/orgs","repos_url":"https://api.github.com/users/Altai-man/repos","events_url":"https://api.github.com/users/Altai-man/events{/privacy}","received_events_url":"https://api.github.com/users/Altai-man/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/perl6/doc/labels/big","name":"big","color":"f72bc1"}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2016-07-28T22:08:02Z","updated_at":"2016-07-28T22:32:58Z","closed_at":null,"body":"See https://github.com/perl6/doc/issues/761#issuecomment-236023547\r\n\r\nTL;DR: right now we don't have a single \"official\" output format for our examples, and everyone who writes documentation uses their own style. It's bad if we want to test our examples result automatically in the future. Our current formatting variants:\r\n* `#-> result`\r\n* `# result`\r\n* `# OUTPUT: «result␤»`\r\n\r\nPlease, if you want to propose your own \"style\" - do it with a comment or just edit this message.\r\nWe need opinions about what style is best.\r\n\r\nPersonally, I'd go with `# result`, since it's really easy to write and read.\r\n\r\nThis issue is marked as `big`, because after selection we also need to rewrite all output results that don't match new \"official\" format line."},"comment":{"url":"https://api.github.com/repos/perl6/doc/issues/comments/236045175","html_url":"https://github.com/perl6/doc/issues/776#issuecomment-236045175","issue_url":"https://api.github.com/repos/perl6/doc/issues/776","id":236045175,"user":{"login":"zoffixznet","id":5747918,"avatar_url":"https://avatars.githubusercontent.com/u/5747918?v=3","gravatar_id":"","url":"https://api.github.com/users/zoffixznet","html_url":"https://github.com/zoffixznet","followers_url":"https://api.github.com/users/zoffixznet/followers","following_url":"https://api.github.com/users/zoffixznet/following{/other_user}","gists_url":"https://api.github.com/users/zoffixznet/gists{/gist_id}","starred_url":"https://api.github.com/users/zoffixznet/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/zoffixznet/subscriptions","organizations_url":"https://api.github.com/users/zoffixznet/orgs","repos_url":"https://api.github.com/users/zoffixznet/repos","events_url":"https://api.github.com/users/zoffixznet/events{/privacy}","received_events_url":"https://api.github.com/users/zoffixznet/received_events","type":"User","site_admin":false},"created_at":"2016-07-28T22:32:57Z","updated_at":"2016-07-28T22:32:57Z","body":"I like using the following, as the this way multi-line output aligns well and it's clear that it's output.\r\n\r\n```\r\n# OUTPUT:\r\n# result\r\n```\r\n\r\nI'm against using `# result`, because it'd conflict with regular comments, especially when we do automated output check and I'm against `OUTPUT: «result␤»` because it's hard to type the fancy-pants symbols (I don't even know how to type them on my phone at all).\r\n"}}
{"actor":{"display_login":"zoffixznet"}}