{"action":"created","issue":{"url":"https://api.github.com/repos/symfony/symfony-docs/issues/6484","repository_url":"https://api.github.com/repos/symfony/symfony-docs","labels_url":"https://api.github.com/repos/symfony/symfony-docs/issues/6484/labels{/name}","comments_url":"https://api.github.com/repos/symfony/symfony-docs/issues/6484/comments","events_url":"https://api.github.com/repos/symfony/symfony-docs/issues/6484/events","html_url":"https://github.com/symfony/symfony-docs/issues/6484","id":148967389,"number":6484,"title":"[RFC] [Proposal] Code snippet convention","user":{"login":"phansys","id":1231441,"avatar_url":"https://avatars.githubusercontent.com/u/1231441?v=3","gravatar_id":"","url":"https://api.github.com/users/phansys","html_url":"https://github.com/phansys","followers_url":"https://api.github.com/users/phansys/followers","following_url":"https://api.github.com/users/phansys/following{/other_user}","gists_url":"https://api.github.com/users/phansys/gists{/gist_id}","starred_url":"https://api.github.com/users/phansys/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/phansys/subscriptions","organizations_url":"https://api.github.com/users/phansys/orgs","repos_url":"https://api.github.com/users/phansys/repos","events_url":"https://api.github.com/users/phansys/events{/privacy}","received_events_url":"https://api.github.com/users/phansys/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2016-04-17T16:22:32Z","updated_at":"2016-04-17T16:30:35Z","closed_at":null,"body":"Use backticks when referencing functions, classes, variables, etc. This should be the same for error and exception messages, docblock descriptions, comments or wherever any of these elements are pointed. \r\n\r\nBy instance:\r\n```php\r\n/**\r\n * @return string\r\n *\r\n * @deprecated Since version 2.8 and will be removed in 3.0. Use `Acme\\Baz::someMethod()` instead. \r\n */\r\npublic function someDeprecatedMethod()\r\n{\r\n    @trigger_error(sprintf('The `%s()` method is deprecated since version 2.8 and will be removed in 3.0. Use `Acme\\Baz::someMethod()` instead.', __METHOD__), E_USER_DEPRECATED);\r\n\r\n    return Baz::someMethod();\r\n}\r\n```"},"comment":{"url":"https://api.github.com/repos/symfony/symfony-docs/issues/comments/211052730","html_url":"https://github.com/symfony/symfony-docs/issues/6484#issuecomment-211052730","issue_url":"https://api.github.com/repos/symfony/symfony-docs/issues/6484","id":211052730,"user":{"login":"phansys","id":1231441,"avatar_url":"https://avatars.githubusercontent.com/u/1231441?v=3","gravatar_id":"","url":"https://api.github.com/users/phansys","html_url":"https://github.com/phansys","followers_url":"https://api.github.com/users/phansys/followers","following_url":"https://api.github.com/users/phansys/following{/other_user}","gists_url":"https://api.github.com/users/phansys/gists{/gist_id}","starred_url":"https://api.github.com/users/phansys/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/phansys/subscriptions","organizations_url":"https://api.github.com/users/phansys/orgs","repos_url":"https://api.github.com/users/phansys/repos","events_url":"https://api.github.com/users/phansys/events{/privacy}","received_events_url":"https://api.github.com/users/phansys/received_events","type":"User","site_admin":false},"created_at":"2016-04-17T16:30:35Z","updated_at":"2016-04-17T16:30:35Z","body":"I understand your point @WouterJ. I could take this more as an encourage than a rule, in order to allow the move in an easier way. Thank you for your feedback."}}