{"action":"closed","issue":{"url":"https://api.github.com/repos/nengo/nengo/issues/1470","repository_url":"https://api.github.com/repos/nengo/nengo","labels_url":"https://api.github.com/repos/nengo/nengo/issues/1470/labels{/name}","comments_url":"https://api.github.com/repos/nengo/nengo/issues/1470/comments","events_url":"https://api.github.com/repos/nengo/nengo/issues/1470/events","html_url":"https://github.com/nengo/nengo/issues/1470","id":358688986,"node_id":"MDU6SXNzdWUzNTg2ODg5ODY=","number":1470,"title":"Clarifying spa.State documentation","user":{"login":"arvoelke","id":5420057,"node_id":"MDQ6VXNlcjU0MjAwNTc=","avatar_url":"https://avatars2.githubusercontent.com/u/5420057?v=4","gravatar_id":"","url":"https://api.github.com/users/arvoelke","html_url":"https://github.com/arvoelke","followers_url":"https://api.github.com/users/arvoelke/followers","following_url":"https://api.github.com/users/arvoelke/following{/other_user}","gists_url":"https://api.github.com/users/arvoelke/gists{/gist_id}","starred_url":"https://api.github.com/users/arvoelke/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arvoelke/subscriptions","organizations_url":"https://api.github.com/users/arvoelke/orgs","repos_url":"https://api.github.com/users/arvoelke/repos","events_url":"https://api.github.com/users/arvoelke/events{/privacy}","received_events_url":"https://api.github.com/users/arvoelke/received_events","type":"User","site_admin":false},"labels":[{"id":252563196,"node_id":"MDU6TGFiZWwyNTI1NjMxOTY=","url":"https://api.github.com/repos/nengo/nengo/labels/document%20this","name":"document this","color":"c7def8","default":false},{"id":120548678,"node_id":"MDU6TGFiZWwxMjA1NDg2Nzg=","url":"https://api.github.com/repos/nengo/nengo/labels/low%20hanging%20fruit","name":"low hanging fruit","color":"bfe5bf","default":false}],"state":"closed","locked":false,"assignee":{"login":"arvoelke","id":5420057,"node_id":"MDQ6VXNlcjU0MjAwNTc=","avatar_url":"https://avatars2.githubusercontent.com/u/5420057?v=4","gravatar_id":"","url":"https://api.github.com/users/arvoelke","html_url":"https://github.com/arvoelke","followers_url":"https://api.github.com/users/arvoelke/followers","following_url":"https://api.github.com/users/arvoelke/following{/other_user}","gists_url":"https://api.github.com/users/arvoelke/gists{/gist_id}","starred_url":"https://api.github.com/users/arvoelke/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arvoelke/subscriptions","organizations_url":"https://api.github.com/users/arvoelke/orgs","repos_url":"https://api.github.com/users/arvoelke/repos","events_url":"https://api.github.com/users/arvoelke/events{/privacy}","received_events_url":"https://api.github.com/users/arvoelke/received_events","type":"User","site_admin":false},"assignees":[{"login":"arvoelke","id":5420057,"node_id":"MDQ6VXNlcjU0MjAwNTc=","avatar_url":"https://avatars2.githubusercontent.com/u/5420057?v=4","gravatar_id":"","url":"https://api.github.com/users/arvoelke","html_url":"https://github.com/arvoelke","followers_url":"https://api.github.com/users/arvoelke/followers","following_url":"https://api.github.com/users/arvoelke/following{/other_user}","gists_url":"https://api.github.com/users/arvoelke/gists{/gist_id}","starred_url":"https://api.github.com/users/arvoelke/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arvoelke/subscriptions","organizations_url":"https://api.github.com/users/arvoelke/orgs","repos_url":"https://api.github.com/users/arvoelke/repos","events_url":"https://api.github.com/users/arvoelke/events{/privacy}","received_events_url":"https://api.github.com/users/arvoelke/received_events","type":"User","site_admin":false}],"milestone":null,"comments":0,"created_at":"2018-09-10T16:00:09Z","updated_at":"2019-03-07T16:57:21Z","closed_at":"2019-03-07T16:57:21Z","author_association":"CONTRIBUTOR","body":"Came across this while helping with the forum post: https://forum.nengo.ai/t/what-is-the-attribute-of-subdimensions/634\r\n\r\nThe documentation for `nengo.spa.State` reads:\r\n\r\n```\r\n    subdimensions : int, optional (Default: 16)\r\n        Size of the individual ensembles making up the vector.\r\n        Must divide ``dimensions`` evenly.\r\n```\r\n\r\nIt could help to change this to:\r\n\r\n```\r\n    subdimensions : int, optional (Default: 16)\r\n        The dimension of the individual ensembles making up the vector.\r\n        Must divide ``dimensions`` evenly. The number of sub-ensembles\r\n        will be ``dimensions // subdimensions``.\r\n```\r\n\r\nAlso, there is:\r\n\r\n```\r\n    neurons_per_dimensions : int, optional (Default: 50)\r\n        Number of neurons in an ensemble will be\r\n        ``neurons_per_dimensions * subdimensions``.\r\n```\r\n\r\nThe parameter name is `neurons_per_dimension` (without an 's'). I think it would be clearer to say:\r\n\r\n```\r\n    neurons_per_dimension : int, optional (Default: 50)\r\n        Number of neurons in each ensemble will be\r\n        ``neurons_per_dimension * subdimensions`` for a\r\n        total of ``neurons_per_dimension * dimensions`` neurons.\r\n```"}}
{"actor":{"display_login":"hunse"}}