{"action":"closed","issue":{"url":"https://api.github.com/repos/google/vim-codefmt/issues/11","labels_url":"https://api.github.com/repos/google/vim-codefmt/issues/11/labels{/name}","comments_url":"https://api.github.com/repos/google/vim-codefmt/issues/11/comments","events_url":"https://api.github.com/repos/google/vim-codefmt/issues/11/events","html_url":"https://github.com/google/vim-codefmt/issues/11","id":55362060,"number":11,"title":"Clean up codefmt vroom files","user":{"login":"dbarnett","id":65244,"avatar_url":"https://avatars.githubusercontent.com/u/65244?v=3","gravatar_id":"","url":"https://api.github.com/users/dbarnett","html_url":"https://github.com/dbarnett","followers_url":"https://api.github.com/users/dbarnett/followers","following_url":"https://api.github.com/users/dbarnett/following{/other_user}","gists_url":"https://api.github.com/users/dbarnett/gists{/gist_id}","starred_url":"https://api.github.com/users/dbarnett/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dbarnett/subscriptions","organizations_url":"https://api.github.com/users/dbarnett/orgs","repos_url":"https://api.github.com/users/dbarnett/repos","events_url":"https://api.github.com/users/dbarnett/events{/privacy}","received_events_url":"https://api.github.com/users/dbarnett/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/google/vim-codefmt/labels/enhancement","name":"enhancement","color":"84b6eb"}],"state":"closed","locked":false,"assignee":{"login":"dbarnett","id":65244,"avatar_url":"https://avatars.githubusercontent.com/u/65244?v=3","gravatar_id":"","url":"https://api.github.com/users/dbarnett","html_url":"https://github.com/dbarnett","followers_url":"https://api.github.com/users/dbarnett/followers","following_url":"https://api.github.com/users/dbarnett/following{/other_user}","gists_url":"https://api.github.com/users/dbarnett/gists{/gist_id}","starred_url":"https://api.github.com/users/dbarnett/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dbarnett/subscriptions","organizations_url":"https://api.github.com/users/dbarnett/orgs","repos_url":"https://api.github.com/users/dbarnett/repos","events_url":"https://api.github.com/users/dbarnett/events{/privacy}","received_events_url":"https://api.github.com/users/dbarnett/received_events","type":"User","site_admin":false},"milestone":null,"comments":0,"created_at":"2015-01-24T07:20:08Z","updated_at":"2015-01-28T19:37:03Z","closed_at":"2015-01-28T19:37:03Z","body":"The codefmt vroom files are pretty good for test coverage right now but not very friendly and readable as \"executable documentation\". Compare to the glaive docs at https://github.com/google/vim-glaive/tree/master/vroom as an A+ example. Improvements to consider:\r\n  * Add more introductory text and a \"table of contents\" in main.vroom. Consider renaming to codefmt.vroom.\r\n  * Split off a separate formatters.vroom file for testing the built-in formatters and consider using very simple dummy formatters in the other files.\r\n  * Cut down on repetition. It's not easy right now to see at a glance what each executable section is testing/demonstrating for all of the verbose syntax."}}