{"action":"created","comment":{"url":"https://api.github.com/repos/spoofax-shell/doc/pulls/comments/67040410","id":67040410,"diff_hunk":"@@ -4,31 +4,36 @@ \\section{Requirements Analysis}\n Defining requirements upfront is important for several reasons: it is a contract\n between the developers and the client, it guides the product development, it\n enables the client to track the progress and finally it allows validation of the\n-deliverable. These requirements are listed in this section.\n+deliverable. The requirements are listed in this section.\n \n \\subsection{Design goals}\n \\label{ssec:goals}\n \n The client has expressed some high-level requirements, which are listed in this\n subsection as design goals in order of priority. The design goals serve as an\n-important guideline when defining and implement the invidual requirements. As\n+important guideline when defining and implementing the invidual requirements. As\n such, they can be considered the bounds within which all requirements must fit.\n \n-\\paragraph{Language-agnostic} The REPL should work with all languages\n-defined with Spoofax. This means that no assumptions can be made about any\n-language constructs or syntax.\n+\\paragraph{Language-agnostic} The REPL should not make any assumptions about its\n+host language: it must work with all languages defined with Spoofax. This also\n+means that a language designer should not have to do any additional work to get","path":"final/problem-def-ana/require-ana.tex","position":21,"original_position":21,"commit_id":"d1f236d960ba5d83174630fb8bfd1a9ab71c7672","original_commit_id":"d1f236d960ba5d83174630fb8bfd1a9ab71c7672","user":{"login":"gfokkema","id":5970912,"avatar_url":"https://avatars.githubusercontent.com/u/5970912?v=3","gravatar_id":"","url":"https://api.github.com/users/gfokkema","html_url":"https://github.com/gfokkema","followers_url":"https://api.github.com/users/gfokkema/followers","following_url":"https://api.github.com/users/gfokkema/following{/other_user}","gists_url":"https://api.github.com/users/gfokkema/gists{/gist_id}","starred_url":"https://api.github.com/users/gfokkema/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gfokkema/subscriptions","organizations_url":"https://api.github.com/users/gfokkema/orgs","repos_url":"https://api.github.com/users/gfokkema/repos","events_url":"https://api.github.com/users/gfokkema/events{/privacy}","received_events_url":"https://api.github.com/users/gfokkema/received_events","type":"User","site_admin":false},"body":"we **are** requiring the designer to do additional work to get a REPL, so I think this should be rewritten.","created_at":"2016-06-14T19:31:49Z","updated_at":"2016-06-14T19:31:49Z","html_url":"https://github.com/spoofax-shell/doc/pull/47#discussion_r67040410","pull_request_url":"https://api.github.com/repos/spoofax-shell/doc/pulls/47","_links":{"self":{"href":"https://api.github.com/repos/spoofax-shell/doc/pulls/comments/67040410"},"html":{"href":"https://github.com/spoofax-shell/doc/pull/47#discussion_r67040410"},"pull_request":{"href":"https://api.github.com/repos/spoofax-shell/doc/pulls/47"}}},"pull_request":{"url":"https://api.github.com/repos/spoofax-shell/doc/pulls/47","id":73728416,"html_url":"https://github.com/spoofax-shell/doc/pull/47","diff_url":"https://github.com/spoofax-shell/doc/pull/47.diff","patch_url":"https://github.com/spoofax-shell/doc/pull/47.patch","issue_url":"https://api.github.com/repos/spoofax-shell/doc/issues/47","number":47,"state":"open","locked":false,"title":"[RFC] Update chapter 3","user":{"login":"Unia","id":1260727,"avatar_url":"https://avatars.githubusercontent.com/u/1260727?v=3","gravatar_id":"","url":"https://api.github.com/users/Unia","html_url":"https://github.com/Unia","followers_url":"https://api.github.com/users/Unia/followers","following_url":"https://api.github.com/users/Unia/following{/other_user}","gists_url":"https://api.github.com/users/Unia/gists{/gist_id}","starred_url":"https://api.github.com/users/Unia/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Unia/subscriptions","organizations_url":"https://api.github.com/users/Unia/orgs","repos_url":"https://api.github.com/users/Unia/repos","events_url":"https://api.github.com/users/Unia/events{/privacy}","received_events_url":"https://api.github.com/users/Unia/received_events","type":"User","site_admin":false},"body":"Branched from #46.\r\n\r\nRemarks on the problem definition section:\r\n\r\n1. Are there any more questions we should/could add?\r\n\r\nRemarks on the problem analysis section:\r\n\r\n1. In the section about the execution model, we (sh|c)ould mention just trying different start symbols.\r\n2. Maybe we should remove the paragraph about detecting unfinished expressions, as it has never been a problem: the console input editor works well as-is, and in Eclipse a multiline input editor is always available.\r\n3. Are there more problems to discuss, perhaps?\r\n\r\nRemarks on the requirements analysis section:\r\n\r\n1. Please see the FIXMEs and TODOs in the tex file.\r\n2. ~~The requirements refer to literate programming, which is explained in chapter 7. That's possibly kind of confusing -- what to do?~~ Literate programming has been moved to chapter 2 in #48.\r\n3. Does the minimal viable product require an explanation as to **why** only the must haves and, more importantly perhaps, **why** only the first two design goals?\r\n4. This section is the only section that still mentions \"all languages\", which Hendrik had comments on: `In final report, be more clear about 'work with all languages', since this can be interpreted as 'work without extra effort ...'.` I believe I removed that assumption, but please verify.","created_at":"2016-06-14T12:12:13Z","updated_at":"2016-06-14T19:31:49Z","closed_at":null,"merged_at":null,"merge_commit_sha":"41142763debcc35d5ad5ca62776e28340a9a4fc1","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/spoofax-shell/doc/pulls/47/commits","review_comments_url":"https://api.github.com/repos/spoofax-shell/doc/pulls/47/comments","review_comment_url":"https://api.github.com/repos/spoofax-shell/doc/pulls/comments{/number}","comments_url":"https://api.github.com/repos/spoofax-shell/doc/issues/47/comments","statuses_url":"https://api.github.com/repos/spoofax-shell/doc/statuses/d1f236d960ba5d83174630fb8bfd1a9ab71c7672","head":{"label":"spoofax-shell:update-chapter-3","ref":"update-chapter-3","sha":"d1f236d960ba5d83174630fb8bfd1a9ab71c7672","user":{"login":"spoofax-shell","id":18665559,"avatar_url":"https://avatars.githubusercontent.com/u/18665559?v=3","gravatar_id":"","url":"https://api.github.com/users/spoofax-shell","html_url":"https://github.com/spoofax-shell","followers_url":"https://api.github.com/users/spoofax-shell/followers","following_url":"https://api.github.com/users/spoofax-shell/following{/other_user}","gists_url":"https://api.github.com/users/spoofax-shell/gists{/gist_id}","starred_url":"https://api.github.com/users/spoofax-shell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/spoofax-shell/subscriptions","organizations_url":"https://api.github.com/users/spoofax-shell/orgs","repos_url":"https://api.github.com/users/spoofax-shell/repos","events_url":"https://api.github.com/users/spoofax-shell/events{/privacy}","received_events_url":"https://api.github.com/users/spoofax-shell/received_events","type":"Organization","site_admin":false},"repo":{"id":56597361,"name":"doc","full_name":"spoofax-shell/doc","owner":{"login":"spoofax-shell","id":18665559,"avatar_url":"https://avatars.githubusercontent.com/u/18665559?v=3","gravatar_id":"","url":"https://api.github.com/users/spoofax-shell","html_url":"https://github.com/spoofax-shell","followers_url":"https://api.github.com/users/spoofax-shell/followers","following_url":"https://api.github.com/users/spoofax-shell/following{/other_user}","gists_url":"https://api.github.com/users/spoofax-shell/gists{/gist_id}","starred_url":"https://api.github.com/users/spoofax-shell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/spoofax-shell/subscriptions","organizations_url":"https://api.github.com/users/spoofax-shell/orgs","repos_url":"https://api.github.com/users/spoofax-shell/repos","events_url":"https://api.github.com/users/spoofax-shell/events{/privacy}","received_events_url":"https://api.github.com/users/spoofax-shell/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/spoofax-shell/doc","description":"TI3806 documents","fork":false,"url":"https://api.github.com/repos/spoofax-shell/doc","forks_url":"https://api.github.com/repos/spoofax-shell/doc/forks","keys_url":"https://api.github.com/repos/spoofax-shell/doc/keys{/key_id}","collaborators_url":"https://api.github.com/repos/spoofax-shell/doc/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/spoofax-shell/doc/teams","hooks_url":"https://api.github.com/repos/spoofax-shell/doc/hooks","issue_events_url":"https://api.github.com/repos/spoofax-shell/doc/issues/events{/number}","events_url":"https://api.github.com/repos/spoofax-shell/doc/events","assignees_url":"https://api.github.com/repos/spoofax-shell/doc/assignees{/user}","branches_url":"https://api.github.com/repos/spoofax-shell/doc/branches{/branch}","tags_url":"https://api.github.com/repos/spoofax-shell/doc/tags","blobs_url":"https://api.github.com/repos/spoofax-shell/doc/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/spoofax-shell/doc/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/spoofax-shell/doc/git/refs{/sha}","trees_url":"https://api.github.com/repos/spoofax-shell/doc/git/trees{/sha}","statuses_url":"https://api.github.com/repos/spoofax-shell/doc/statuses/{sha}","languages_url":"https://api.github.com/repos/spoofax-shell/doc/languages","stargazers_url":"https://api.github.com/repos/spoofax-shell/doc/stargazers","contributors_url":"https://api.github.com/repos/spoofax-shell/doc/contributors","subscribers_url":"https://api.github.com/repos/spoofax-shell/doc/subscribers","subscription_url":"https://api.github.com/repos/spoofax-shell/doc/subscription","commits_url":"https://api.github.com/repos/spoofax-shell/doc/commits{/sha}","git_commits_url":"https://api.github.com/repos/spoofax-shell/doc/git/commits{/sha}","comments_url":"https://api.github.com/repos/spoofax-shell/doc/comments{/number}","issue_comment_url":"https://api.github.com/repos/spoofax-shell/doc/issues/comments{/number}","contents_url":"https://api.github.com/repos/spoofax-shell/doc/contents/{+path}","compare_url":"https://api.github.com/repos/spoofax-shell/doc/compare/{base}...{head}","merges_url":"https://api.github.com/repos/spoofax-shell/doc/merges","archive_url":"https://api.github.com/repos/spoofax-shell/doc/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/spoofax-shell/doc/downloads","issues_url":"https://api.github.com/repos/spoofax-shell/doc/issues{/number}","pulls_url":"https://api.github.com/repos/spoofax-shell/doc/pulls{/number}","milestones_url":"https://api.github.com/repos/spoofax-shell/doc/milestones{/number}","notifications_url":"https://api.github.com/repos/spoofax-shell/doc/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/spoofax-shell/doc/labels{/name}","releases_url":"https://api.github.com/repos/spoofax-shell/doc/releases{/id}","deployments_url":"https://api.github.com/repos/spoofax-shell/doc/deployments","created_at":"2016-04-19T13:05:31Z","updated_at":"2016-05-01T18:51:51Z","pushed_at":"2016-06-14T16:06:42Z","git_url":"git://github.com/spoofax-shell/doc.git","ssh_url":"git@github.com:spoofax-shell/doc.git","clone_url":"https://github.com/spoofax-shell/doc.git","svn_url":"https://github.com/spoofax-shell/doc","homepage":"","size":5527,"stargazers_count":0,"watchers_count":0,"language":"TeX","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":7,"forks":0,"open_issues":7,"watchers":0,"default_branch":"master"}},"base":{"label":"spoofax-shell:master","ref":"master","sha":"fa89d7ad590b28fcefedb1c70316d6b6bd87788c","user":{"login":"spoofax-shell","id":18665559,"avatar_url":"https://avatars.githubusercontent.com/u/18665559?v=3","gravatar_id":"","url":"https://api.github.com/users/spoofax-shell","html_url":"https://github.com/spoofax-shell","followers_url":"https://api.github.com/users/spoofax-shell/followers","following_url":"https://api.github.com/users/spoofax-shell/following{/other_user}","gists_url":"https://api.github.com/users/spoofax-shell/gists{/gist_id}","starred_url":"https://api.github.com/users/spoofax-shell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/spoofax-shell/subscriptions","organizations_url":"https://api.github.com/users/spoofax-shell/orgs","repos_url":"https://api.github.com/users/spoofax-shell/repos","events_url":"https://api.github.com/users/spoofax-shell/events{/privacy}","received_events_url":"https://api.github.com/users/spoofax-shell/received_events","type":"Organization","site_admin":false},"repo":{"id":56597361,"name":"doc","full_name":"spoofax-shell/doc","owner":{"login":"spoofax-shell","id":18665559,"avatar_url":"https://avatars.githubusercontent.com/u/18665559?v=3","gravatar_id":"","url":"https://api.github.com/users/spoofax-shell","html_url":"https://github.com/spoofax-shell","followers_url":"https://api.github.com/users/spoofax-shell/followers","following_url":"https://api.github.com/users/spoofax-shell/following{/other_user}","gists_url":"https://api.github.com/users/spoofax-shell/gists{/gist_id}","starred_url":"https://api.github.com/users/spoofax-shell/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/spoofax-shell/subscriptions","organizations_url":"https://api.github.com/users/spoofax-shell/orgs","repos_url":"https://api.github.com/users/spoofax-shell/repos","events_url":"https://api.github.com/users/spoofax-shell/events{/privacy}","received_events_url":"https://api.github.com/users/spoofax-shell/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/spoofax-shell/doc","description":"TI3806 documents","fork":false,"url":"https://api.github.com/repos/spoofax-shell/doc","forks_url":"https://api.github.com/repos/spoofax-shell/doc/forks","keys_url":"https://api.github.com/repos/spoofax-shell/doc/keys{/key_id}","collaborators_url":"https://api.github.com/repos/spoofax-shell/doc/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/spoofax-shell/doc/teams","hooks_url":"https://api.github.com/repos/spoofax-shell/doc/hooks","issue_events_url":"https://api.github.com/repos/spoofax-shell/doc/issues/events{/number}","events_url":"https://api.github.com/repos/spoofax-shell/doc/events","assignees_url":"https://api.github.com/repos/spoofax-shell/doc/assignees{/user}","branches_url":"https://api.github.com/repos/spoofax-shell/doc/branches{/branch}","tags_url":"https://api.github.com/repos/spoofax-shell/doc/tags","blobs_url":"https://api.github.com/repos/spoofax-shell/doc/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/spoofax-shell/doc/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/spoofax-shell/doc/git/refs{/sha}","trees_url":"https://api.github.com/repos/spoofax-shell/doc/git/trees{/sha}","statuses_url":"https://api.github.com/repos/spoofax-shell/doc/statuses/{sha}","languages_url":"https://api.github.com/repos/spoofax-shell/doc/languages","stargazers_url":"https://api.github.com/repos/spoofax-shell/doc/stargazers","contributors_url":"https://api.github.com/repos/spoofax-shell/doc/contributors","subscribers_url":"https://api.github.com/repos/spoofax-shell/doc/subscribers","subscription_url":"https://api.github.com/repos/spoofax-shell/doc/subscription","commits_url":"https://api.github.com/repos/spoofax-shell/doc/commits{/sha}","git_commits_url":"https://api.github.com/repos/spoofax-shell/doc/git/commits{/sha}","comments_url":"https://api.github.com/repos/spoofax-shell/doc/comments{/number}","issue_comment_url":"https://api.github.com/repos/spoofax-shell/doc/issues/comments{/number}","contents_url":"https://api.github.com/repos/spoofax-shell/doc/contents/{+path}","compare_url":"https://api.github.com/repos/spoofax-shell/doc/compare/{base}...{head}","merges_url":"https://api.github.com/repos/spoofax-shell/doc/merges","archive_url":"https://api.github.com/repos/spoofax-shell/doc/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/spoofax-shell/doc/downloads","issues_url":"https://api.github.com/repos/spoofax-shell/doc/issues{/number}","pulls_url":"https://api.github.com/repos/spoofax-shell/doc/pulls{/number}","milestones_url":"https://api.github.com/repos/spoofax-shell/doc/milestones{/number}","notifications_url":"https://api.github.com/repos/spoofax-shell/doc/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/spoofax-shell/doc/labels{/name}","releases_url":"https://api.github.com/repos/spoofax-shell/doc/releases{/id}","deployments_url":"https://api.github.com/repos/spoofax-shell/doc/deployments","created_at":"2016-04-19T13:05:31Z","updated_at":"2016-05-01T18:51:51Z","pushed_at":"2016-06-14T16:06:42Z","git_url":"git://github.com/spoofax-shell/doc.git","ssh_url":"git@github.com:spoofax-shell/doc.git","clone_url":"https://github.com/spoofax-shell/doc.git","svn_url":"https://github.com/spoofax-shell/doc","homepage":"","size":5527,"stargazers_count":0,"watchers_count":0,"language":"TeX","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":7,"forks":0,"open_issues":7,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/spoofax-shell/doc/pulls/47"},"html":{"href":"https://github.com/spoofax-shell/doc/pull/47"},"issue":{"href":"https://api.github.com/repos/spoofax-shell/doc/issues/47"},"comments":{"href":"https://api.github.com/repos/spoofax-shell/doc/issues/47/comments"},"review_comments":{"href":"https://api.github.com/repos/spoofax-shell/doc/pulls/47/comments"},"review_comment":{"href":"https://api.github.com/repos/spoofax-shell/doc/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/spoofax-shell/doc/pulls/47/commits"},"statuses":{"href":"https://api.github.com/repos/spoofax-shell/doc/statuses/d1f236d960ba5d83174630fb8bfd1a9ab71c7672"}}}}
{"actor":{"display_login":"gfokkema"}}