{"action":"created","comment":{"url":"https://api.github.com/repos/gonum/matrix/pulls/comments/43955296","id":43955296,"diff_hunk":"@@ -0,0 +1,107 @@\n+// Generated by running\n+//  go generate github.com/gonum/matrix\n+// DO NOT EDIT.\n+\n+// Copyright ©2015 The gonum Authors. All rights reserved.\n+// Use of this source code is governed by a BSD-style\n+// license that can be found in the LICENSE file.\n+\n+// Package matrix provides common error handling mechanisms for matrix operations\n+// in mat64 and cmat128.\n+//\n+// Overview\n+//\n+// This section provides a quick overview of the matrix package. The following\n+// sections provide more in depth commentary.\n+//\n+// matrix provides:\n+//  - Error type definitions\n+//  - Error recovery mechanisms\n+//  - Common constants used by mat64 and cmat128\n+//\n+// Errors\n+//\n+// The mat64 and cmat128 matrix packages share a common set of errors\n+// provided by matrix via the matrix.Error type.\n+//\n+// Errors are either returned directly or used as the parameter of a panic\n+// depending on the class of error encountered. As is usually the case in\n+// Go code, returned errors indicate that a call was not able to complete\n+// successfully while panics generally indicate a programmer error or an\n+// unrecoverable error.\n+//\n+// Examples of each type are found in the mat64 Solve methods, which find\n+// x such that A*x = b.\n+//\n+// An error value is returned from the function or method when the operation\n+// can meaningfully fail. The Solve operation is cannot complete if A is\n+// singular. However, determining the singularity of A is most easily\n+// discovered during the Solve procedure itself and is a valid result from\n+// the operation, so in this case an error is returned.\n+//\n+// A function will panic when the input parameters are inappropriate for\n+// the function. In Solve, for example, the number of rows of each input\n+// matrix must be equal because of the rules of matrix multiplication.\n+// Similarly, for solving A*x = b, a non-zero receiver must have the same\n+// number of rows as A has columns and must have the same number of columns\n+// as b. In all cases where a function will panic, conditions that would","path":"doc.go","position":47,"original_position":47,"commit_id":"aeeb0d5c01821277c7c55465d5812cf4d3a2b8a3","original_commit_id":"aeeb0d5c01821277c7c55465d5812cf4d3a2b8a3","user":{"login":"kortschak","id":275221,"avatar_url":"https://avatars.githubusercontent.com/u/275221?v=3","gravatar_id":"","url":"https://api.github.com/users/kortschak","html_url":"https://github.com/kortschak","followers_url":"https://api.github.com/users/kortschak/followers","following_url":"https://api.github.com/users/kortschak/following{/other_user}","gists_url":"https://api.github.com/users/kortschak/gists{/gist_id}","starred_url":"https://api.github.com/users/kortschak/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kortschak/subscriptions","organizations_url":"https://api.github.com/users/kortschak/orgs","repos_url":"https://api.github.com/users/kortschak/repos","events_url":"https://api.github.com/users/kortschak/events{/privacy}","received_events_url":"https://api.github.com/users/kortschak/received_events","type":"User","site_admin":false},"body":"I don't think this is the basis - it puts the cart before the horse. We are mimicking a type system (we are actually implementing a type system), just one that is determined at run time. We preclude certain sets of behaviours by prohibiting some user actions. This is the foremost goal. The corollary of that prohibition is that we should (and do) make it possible for the user to determine whether they would be breaking the rules (if, for example, they were given untrusted input). The wording here reflects that priority. The converse, e.g. trying to solve a system which has a singular input, is a perfectly legitimate thing to do in the rules of linear algebra, it just fails. This is the difference IMO.","created_at":"2015-11-04T23:14:39Z","updated_at":"2015-11-04T23:14:39Z","html_url":"https://github.com/gonum/matrix/pull/285#discussion_r43955296","pull_request_url":"https://api.github.com/repos/gonum/matrix/pulls/285","_links":{"self":{"href":"https://api.github.com/repos/gonum/matrix/pulls/comments/43955296"},"html":{"href":"https://github.com/gonum/matrix/pull/285#discussion_r43955296"},"pull_request":{"href":"https://api.github.com/repos/gonum/matrix/pulls/285"}}},"pull_request":{"url":"https://api.github.com/repos/gonum/matrix/pulls/285","id":48654289,"html_url":"https://github.com/gonum/matrix/pull/285","diff_url":"https://github.com/gonum/matrix/pull/285.diff","patch_url":"https://github.com/gonum/matrix/pull/285.patch","issue_url":"https://api.github.com/repos/gonum/matrix/issues/285","number":285,"state":"open","locked":false,"title":"all: generate docs","user":{"login":"kortschak","id":275221,"avatar_url":"https://avatars.githubusercontent.com/u/275221?v=3","gravatar_id":"","url":"https://api.github.com/users/kortschak","html_url":"https://github.com/kortschak","followers_url":"https://api.github.com/users/kortschak/followers","following_url":"https://api.github.com/users/kortschak/following{/other_user}","gists_url":"https://api.github.com/users/kortschak/gists{/gist_id}","starred_url":"https://api.github.com/users/kortschak/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kortschak/subscriptions","organizations_url":"https://api.github.com/users/kortschak/orgs","repos_url":"https://api.github.com/users/kortschak/repos","events_url":"https://api.github.com/users/kortschak/events{/privacy}","received_events_url":"https://api.github.com/users/kortschak/received_events","type":"User","site_admin":false},"body":"@btracey Please take a look.","created_at":"2015-10-24T11:36:43Z","updated_at":"2015-11-04T23:14:40Z","closed_at":null,"merged_at":null,"merge_commit_sha":"0ce8465ed1453bd2d76ecd7ca1c5372dd308012a","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/gonum/matrix/pulls/285/commits","review_comments_url":"https://api.github.com/repos/gonum/matrix/pulls/285/comments","review_comment_url":"https://api.github.com/repos/gonum/matrix/pulls/comments{/number}","comments_url":"https://api.github.com/repos/gonum/matrix/issues/285/comments","statuses_url":"https://api.github.com/repos/gonum/matrix/statuses/aeeb0d5c01821277c7c55465d5812cf4d3a2b8a3","head":{"label":"gonum:docs","ref":"docs","sha":"aeeb0d5c01821277c7c55465d5812cf4d3a2b8a3","user":{"login":"gonum","id":3771091,"avatar_url":"https://avatars.githubusercontent.com/u/3771091?v=3","gravatar_id":"","url":"https://api.github.com/users/gonum","html_url":"https://github.com/gonum","followers_url":"https://api.github.com/users/gonum/followers","following_url":"https://api.github.com/users/gonum/following{/other_user}","gists_url":"https://api.github.com/users/gonum/gists{/gist_id}","starred_url":"https://api.github.com/users/gonum/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gonum/subscriptions","organizations_url":"https://api.github.com/users/gonum/orgs","repos_url":"https://api.github.com/users/gonum/repos","events_url":"https://api.github.com/users/gonum/events{/privacy}","received_events_url":"https://api.github.com/users/gonum/received_events","type":"Organization","site_admin":false},"repo":{"id":8569918,"name":"matrix","full_name":"gonum/matrix","owner":{"login":"gonum","id":3771091,"avatar_url":"https://avatars.githubusercontent.com/u/3771091?v=3","gravatar_id":"","url":"https://api.github.com/users/gonum","html_url":"https://github.com/gonum","followers_url":"https://api.github.com/users/gonum/followers","following_url":"https://api.github.com/users/gonum/following{/other_user}","gists_url":"https://api.github.com/users/gonum/gists{/gist_id}","starred_url":"https://api.github.com/users/gonum/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gonum/subscriptions","organizations_url":"https://api.github.com/users/gonum/orgs","repos_url":"https://api.github.com/users/gonum/repos","events_url":"https://api.github.com/users/gonum/events{/privacy}","received_events_url":"https://api.github.com/users/gonum/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/gonum/matrix","description":"Matrix packages for the Go language.","fork":false,"url":"https://api.github.com/repos/gonum/matrix","forks_url":"https://api.github.com/repos/gonum/matrix/forks","keys_url":"https://api.github.com/repos/gonum/matrix/keys{/key_id}","collaborators_url":"https://api.github.com/repos/gonum/matrix/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/gonum/matrix/teams","hooks_url":"https://api.github.com/repos/gonum/matrix/hooks","issue_events_url":"https://api.github.com/repos/gonum/matrix/issues/events{/number}","events_url":"https://api.github.com/repos/gonum/matrix/events","assignees_url":"https://api.github.com/repos/gonum/matrix/assignees{/user}","branches_url":"https://api.github.com/repos/gonum/matrix/branches{/branch}","tags_url":"https://api.github.com/repos/gonum/matrix/tags","blobs_url":"https://api.github.com/repos/gonum/matrix/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/gonum/matrix/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/gonum/matrix/git/refs{/sha}","trees_url":"https://api.github.com/repos/gonum/matrix/git/trees{/sha}","statuses_url":"https://api.github.com/repos/gonum/matrix/statuses/{sha}","languages_url":"https://api.github.com/repos/gonum/matrix/languages","stargazers_url":"https://api.github.com/repos/gonum/matrix/stargazers","contributors_url":"https://api.github.com/repos/gonum/matrix/contributors","subscribers_url":"https://api.github.com/repos/gonum/matrix/subscribers","subscription_url":"https://api.github.com/repos/gonum/matrix/subscription","commits_url":"https://api.github.com/repos/gonum/matrix/commits{/sha}","git_commits_url":"https://api.github.com/repos/gonum/matrix/git/commits{/sha}","comments_url":"https://api.github.com/repos/gonum/matrix/comments{/number}","issue_comment_url":"https://api.github.com/repos/gonum/matrix/issues/comments{/number}","contents_url":"https://api.github.com/repos/gonum/matrix/contents/{+path}","compare_url":"https://api.github.com/repos/gonum/matrix/compare/{base}...{head}","merges_url":"https://api.github.com/repos/gonum/matrix/merges","archive_url":"https://api.github.com/repos/gonum/matrix/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/gonum/matrix/downloads","issues_url":"https://api.github.com/repos/gonum/matrix/issues{/number}","pulls_url":"https://api.github.com/repos/gonum/matrix/pulls{/number}","milestones_url":"https://api.github.com/repos/gonum/matrix/milestones{/number}","notifications_url":"https://api.github.com/repos/gonum/matrix/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/gonum/matrix/labels{/name}","releases_url":"https://api.github.com/repos/gonum/matrix/releases{/id}","created_at":"2013-03-05T01:59:12Z","updated_at":"2015-11-02T11:20:50Z","pushed_at":"2015-11-04T23:08:42Z","git_url":"git://github.com/gonum/matrix.git","ssh_url":"git@github.com:gonum/matrix.git","clone_url":"https://github.com/gonum/matrix.git","svn_url":"https://github.com/gonum/matrix","homepage":"","size":3358,"stargazers_count":161,"watchers_count":161,"language":"Go","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":25,"mirror_url":null,"open_issues_count":17,"forks":25,"open_issues":17,"watchers":161,"default_branch":"master"}},"base":{"label":"gonum:master","ref":"master","sha":"5bc7326a5233b5959239223f8c29911c82e4a13d","user":{"login":"gonum","id":3771091,"avatar_url":"https://avatars.githubusercontent.com/u/3771091?v=3","gravatar_id":"","url":"https://api.github.com/users/gonum","html_url":"https://github.com/gonum","followers_url":"https://api.github.com/users/gonum/followers","following_url":"https://api.github.com/users/gonum/following{/other_user}","gists_url":"https://api.github.com/users/gonum/gists{/gist_id}","starred_url":"https://api.github.com/users/gonum/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gonum/subscriptions","organizations_url":"https://api.github.com/users/gonum/orgs","repos_url":"https://api.github.com/users/gonum/repos","events_url":"https://api.github.com/users/gonum/events{/privacy}","received_events_url":"https://api.github.com/users/gonum/received_events","type":"Organization","site_admin":false},"repo":{"id":8569918,"name":"matrix","full_name":"gonum/matrix","owner":{"login":"gonum","id":3771091,"avatar_url":"https://avatars.githubusercontent.com/u/3771091?v=3","gravatar_id":"","url":"https://api.github.com/users/gonum","html_url":"https://github.com/gonum","followers_url":"https://api.github.com/users/gonum/followers","following_url":"https://api.github.com/users/gonum/following{/other_user}","gists_url":"https://api.github.com/users/gonum/gists{/gist_id}","starred_url":"https://api.github.com/users/gonum/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gonum/subscriptions","organizations_url":"https://api.github.com/users/gonum/orgs","repos_url":"https://api.github.com/users/gonum/repos","events_url":"https://api.github.com/users/gonum/events{/privacy}","received_events_url":"https://api.github.com/users/gonum/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/gonum/matrix","description":"Matrix packages for the Go language.","fork":false,"url":"https://api.github.com/repos/gonum/matrix","forks_url":"https://api.github.com/repos/gonum/matrix/forks","keys_url":"https://api.github.com/repos/gonum/matrix/keys{/key_id}","collaborators_url":"https://api.github.com/repos/gonum/matrix/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/gonum/matrix/teams","hooks_url":"https://api.github.com/repos/gonum/matrix/hooks","issue_events_url":"https://api.github.com/repos/gonum/matrix/issues/events{/number}","events_url":"https://api.github.com/repos/gonum/matrix/events","assignees_url":"https://api.github.com/repos/gonum/matrix/assignees{/user}","branches_url":"https://api.github.com/repos/gonum/matrix/branches{/branch}","tags_url":"https://api.github.com/repos/gonum/matrix/tags","blobs_url":"https://api.github.com/repos/gonum/matrix/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/gonum/matrix/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/gonum/matrix/git/refs{/sha}","trees_url":"https://api.github.com/repos/gonum/matrix/git/trees{/sha}","statuses_url":"https://api.github.com/repos/gonum/matrix/statuses/{sha}","languages_url":"https://api.github.com/repos/gonum/matrix/languages","stargazers_url":"https://api.github.com/repos/gonum/matrix/stargazers","contributors_url":"https://api.github.com/repos/gonum/matrix/contributors","subscribers_url":"https://api.github.com/repos/gonum/matrix/subscribers","subscription_url":"https://api.github.com/repos/gonum/matrix/subscription","commits_url":"https://api.github.com/repos/gonum/matrix/commits{/sha}","git_commits_url":"https://api.github.com/repos/gonum/matrix/git/commits{/sha}","comments_url":"https://api.github.com/repos/gonum/matrix/comments{/number}","issue_comment_url":"https://api.github.com/repos/gonum/matrix/issues/comments{/number}","contents_url":"https://api.github.com/repos/gonum/matrix/contents/{+path}","compare_url":"https://api.github.com/repos/gonum/matrix/compare/{base}...{head}","merges_url":"https://api.github.com/repos/gonum/matrix/merges","archive_url":"https://api.github.com/repos/gonum/matrix/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/gonum/matrix/downloads","issues_url":"https://api.github.com/repos/gonum/matrix/issues{/number}","pulls_url":"https://api.github.com/repos/gonum/matrix/pulls{/number}","milestones_url":"https://api.github.com/repos/gonum/matrix/milestones{/number}","notifications_url":"https://api.github.com/repos/gonum/matrix/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/gonum/matrix/labels{/name}","releases_url":"https://api.github.com/repos/gonum/matrix/releases{/id}","created_at":"2013-03-05T01:59:12Z","updated_at":"2015-11-02T11:20:50Z","pushed_at":"2015-11-04T23:08:42Z","git_url":"git://github.com/gonum/matrix.git","ssh_url":"git@github.com:gonum/matrix.git","clone_url":"https://github.com/gonum/matrix.git","svn_url":"https://github.com/gonum/matrix","homepage":"","size":3358,"stargazers_count":161,"watchers_count":161,"language":"Go","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":25,"mirror_url":null,"open_issues_count":17,"forks":25,"open_issues":17,"watchers":161,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/gonum/matrix/pulls/285"},"html":{"href":"https://github.com/gonum/matrix/pull/285"},"issue":{"href":"https://api.github.com/repos/gonum/matrix/issues/285"},"comments":{"href":"https://api.github.com/repos/gonum/matrix/issues/285/comments"},"review_comments":{"href":"https://api.github.com/repos/gonum/matrix/pulls/285/comments"},"review_comment":{"href":"https://api.github.com/repos/gonum/matrix/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/gonum/matrix/pulls/285/commits"},"statuses":{"href":"https://api.github.com/repos/gonum/matrix/statuses/aeeb0d5c01821277c7c55465d5812cf4d3a2b8a3"}}}}