{"action":"created","issue":{"url":"https://api.github.com/repos/holochain/holochain-rust/issues/287","repository_url":"https://api.github.com/repos/holochain/holochain-rust","labels_url":"https://api.github.com/repos/holochain/holochain-rust/issues/287/labels{/name}","comments_url":"https://api.github.com/repos/holochain/holochain-rust/issues/287/comments","events_url":"https://api.github.com/repos/holochain/holochain-rust/issues/287/events","html_url":"https://github.com/holochain/holochain-rust/issues/287","id":356828464,"node_id":"MDU6SXNzdWUzNTY4Mjg0NjQ=","number":287,"title":"document naming conventions","user":{"login":"thedavidmeister","id":629710,"node_id":"MDQ6VXNlcjYyOTcxMA==","avatar_url":"https://avatars2.githubusercontent.com/u/629710?v=4","gravatar_id":"","url":"https://api.github.com/users/thedavidmeister","html_url":"https://github.com/thedavidmeister","followers_url":"https://api.github.com/users/thedavidmeister/followers","following_url":"https://api.github.com/users/thedavidmeister/following{/other_user}","gists_url":"https://api.github.com/users/thedavidmeister/gists{/gist_id}","starred_url":"https://api.github.com/users/thedavidmeister/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thedavidmeister/subscriptions","organizations_url":"https://api.github.com/users/thedavidmeister/orgs","repos_url":"https://api.github.com/users/thedavidmeister/repos","events_url":"https://api.github.com/users/thedavidmeister/events{/privacy}","received_events_url":"https://api.github.com/users/thedavidmeister/received_events","type":"User","site_admin":false},"labels":[{"id":937673517,"node_id":"MDU6TGFiZWw5Mzc2NzM1MTc=","url":"https://api.github.com/repos/holochain/holochain-rust/labels/review","name":"review","color":"ededed","default":false}],"state":"open","locked":false,"assignee":{"login":"thedavidmeister","id":629710,"node_id":"MDQ6VXNlcjYyOTcxMA==","avatar_url":"https://avatars2.githubusercontent.com/u/629710?v=4","gravatar_id":"","url":"https://api.github.com/users/thedavidmeister","html_url":"https://github.com/thedavidmeister","followers_url":"https://api.github.com/users/thedavidmeister/followers","following_url":"https://api.github.com/users/thedavidmeister/following{/other_user}","gists_url":"https://api.github.com/users/thedavidmeister/gists{/gist_id}","starred_url":"https://api.github.com/users/thedavidmeister/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thedavidmeister/subscriptions","organizations_url":"https://api.github.com/users/thedavidmeister/orgs","repos_url":"https://api.github.com/users/thedavidmeister/repos","events_url":"https://api.github.com/users/thedavidmeister/events{/privacy}","received_events_url":"https://api.github.com/users/thedavidmeister/received_events","type":"User","site_admin":false},"assignees":[{"login":"thedavidmeister","id":629710,"node_id":"MDQ6VXNlcjYyOTcxMA==","avatar_url":"https://avatars2.githubusercontent.com/u/629710?v=4","gravatar_id":"","url":"https://api.github.com/users/thedavidmeister","html_url":"https://github.com/thedavidmeister","followers_url":"https://api.github.com/users/thedavidmeister/followers","following_url":"https://api.github.com/users/thedavidmeister/following{/other_user}","gists_url":"https://api.github.com/users/thedavidmeister/gists{/gist_id}","starred_url":"https://api.github.com/users/thedavidmeister/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thedavidmeister/subscriptions","organizations_url":"https://api.github.com/users/thedavidmeister/orgs","repos_url":"https://api.github.com/users/thedavidmeister/repos","events_url":"https://api.github.com/users/thedavidmeister/events{/privacy}","received_events_url":"https://api.github.com/users/thedavidmeister/received_events","type":"User","site_admin":false}],"milestone":null,"comments":9,"created_at":"2018-09-04T14:10:56Z","updated_at":"2018-09-05T04:35:37Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"because 👿 💥 🤔 \r\n\r\nas i understand it:\r\n\r\n- `Action` is `VerbNoun` e.g. `GetEntry`\r\n- `ActionResponse` is `ActionName` e.g. `Action::GetEntry` results in `ActionResponse::GetEntry`\r\n- reducer name is `reduce_action_name` e.g. `reduce_get_entry`\r\n- Actor `Protocol` is `VerbNoun` or `Verb` e.g. `PutEntry` or `Setup`\r\n- Result of a `Protocol` is `VerbNounResult` e.g. `PutEntryResult`\r\n- method names that get something are the name of the thing being got, e.g. `entry()`\r\n- method names that have side effect other than get are `verb_noun()` e.g. `put_entry()`\r\n- avoid short names like `t`, `e`, `h` when `table`, `entry`, `header` would be clearer (almost always)\r\n\r\nintent is to align with rust naming conventions https://doc.rust-lang.org/1.0.0/style/style/naming/README.html then fill in the gaps where our own code might be ambiguous\r\n\r\nif in doubt refer to the rust conventions\r\n\r\nif there is no clear fit then make something up, but make it \"self documenting\", i.e. explicit, descriptive and indicative of what it does/is/will happen\r\n\r\nnames should be as \"boring\" as possible"},"comment":{"url":"https://api.github.com/repos/holochain/holochain-rust/issues/comments/418596692","html_url":"https://github.com/holochain/holochain-rust/issues/287#issuecomment-418596692","issue_url":"https://api.github.com/repos/holochain/holochain-rust/issues/287","id":418596692,"node_id":"MDEyOklzc3VlQ29tbWVudDQxODU5NjY5Mg==","user":{"login":"ddd-mtl","id":34140573,"node_id":"MDQ6VXNlcjM0MTQwNTcz","avatar_url":"https://avatars3.githubusercontent.com/u/34140573?v=4","gravatar_id":"","url":"https://api.github.com/users/ddd-mtl","html_url":"https://github.com/ddd-mtl","followers_url":"https://api.github.com/users/ddd-mtl/followers","following_url":"https://api.github.com/users/ddd-mtl/following{/other_user}","gists_url":"https://api.github.com/users/ddd-mtl/gists{/gist_id}","starred_url":"https://api.github.com/users/ddd-mtl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ddd-mtl/subscriptions","organizations_url":"https://api.github.com/users/ddd-mtl/orgs","repos_url":"https://api.github.com/users/ddd-mtl/repos","events_url":"https://api.github.com/users/ddd-mtl/events{/privacy}","received_events_url":"https://api.github.com/users/ddd-mtl/received_events","type":"User","site_admin":false},"created_at":"2018-09-05T04:35:37Z","updated_at":"2018-09-05T04:35:37Z","author_association":"CONTRIBUTOR","body":"@thedavidmeister \r\nYes, we could also use EnumFlags instead of BitFlags, and have it be CamelCase.\r\nBut I read `GetEntryMask::EntryType` as a type, not as a value, whereas I read `GetEntryMask::ENTRY_TYPE` as a (const) value. Like the Rust convention states:\r\n> CamelCase for \"type-level\" constructs (types and traits) and snake_case for \"value-level\" constructs\r\n\r\nSo `hdk::debug(&hdk::GetEntryMask::EntryType)` is in itself a bit confusing to me.\r\n\r\nWhen using C-style enums `GetEntryMask::EntryType` is 'value-level' not 'type-level', so should follow 'value-level' naming convention..."}}
{"actor":{"display_login":"ddd-mtl"}}