{"action":"created","issue":{"url":"https://api.github.com/repos/cypress-io/cypress-documentation/issues/923","repository_url":"https://api.github.com/repos/cypress-io/cypress-documentation","labels_url":"https://api.github.com/repos/cypress-io/cypress-documentation/issues/923/labels{/name}","comments_url":"https://api.github.com/repos/cypress-io/cypress-documentation/issues/923/comments","events_url":"https://api.github.com/repos/cypress-io/cypress-documentation/issues/923/events","html_url":"https://github.com/cypress-io/cypress-documentation/issues/923","id":358827338,"node_id":"MDU6SXNzdWUzNTg4MjczMzg=","number":923,"title":"Double dash formatting could confuse users","user":{"login":"amirrustam","id":334337,"node_id":"MDQ6VXNlcjMzNDMzNw==","avatar_url":"https://avatars0.githubusercontent.com/u/334337?v=4","gravatar_id":"","url":"https://api.github.com/users/amirrustam","html_url":"https://github.com/amirrustam","followers_url":"https://api.github.com/users/amirrustam/followers","following_url":"https://api.github.com/users/amirrustam/following{/other_user}","gists_url":"https://api.github.com/users/amirrustam/gists{/gist_id}","starred_url":"https://api.github.com/users/amirrustam/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/amirrustam/subscriptions","organizations_url":"https://api.github.com/users/amirrustam/orgs","repos_url":"https://api.github.com/users/amirrustam/repos","events_url":"https://api.github.com/users/amirrustam/events{/privacy}","received_events_url":"https://api.github.com/users/amirrustam/received_events","type":"User","site_admin":false},"labels":[{"id":732934344,"node_id":"MDU6TGFiZWw3MzI5MzQzNDQ=","url":"https://api.github.com/repos/cypress-io/cypress-documentation/labels/stage:%20ready%20for%20work","name":"stage: ready for work","color":"ffdf7f","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-09-10T23:09:39Z","updated_at":"2018-09-11T07:57:52Z","closed_at":null,"author_association":"MEMBER","body":"In an info box, the theme seems to combine two dashes into one, turning `--record` into `-record` which can confuse people.\r\n\r\n![screen shot 2018-09-10 at 4 06 32 pm](https://user-images.githubusercontent.com/334337/45329163-e7a29c80-b513-11e8-909d-b8ba7d523fdf.png)\r\n"},"comment":{"url":"https://api.github.com/repos/cypress-io/cypress-documentation/issues/comments/420183019","html_url":"https://github.com/cypress-io/cypress-documentation/issues/923#issuecomment-420183019","issue_url":"https://api.github.com/repos/cypress-io/cypress-documentation/issues/923","id":420183019,"node_id":"MDEyOklzc3VlQ29tbWVudDQyMDE4MzAxOQ==","user":{"login":"richdouglasevans","id":1855109,"node_id":"MDQ6VXNlcjE4NTUxMDk=","avatar_url":"https://avatars1.githubusercontent.com/u/1855109?v=4","gravatar_id":"","url":"https://api.github.com/users/richdouglasevans","html_url":"https://github.com/richdouglasevans","followers_url":"https://api.github.com/users/richdouglasevans/followers","following_url":"https://api.github.com/users/richdouglasevans/following{/other_user}","gists_url":"https://api.github.com/users/richdouglasevans/gists{/gist_id}","starred_url":"https://api.github.com/users/richdouglasevans/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/richdouglasevans/subscriptions","organizations_url":"https://api.github.com/users/richdouglasevans/orgs","repos_url":"https://api.github.com/users/richdouglasevans/repos","events_url":"https://api.github.com/users/richdouglasevans/events{/privacy}","received_events_url":"https://api.github.com/users/richdouglasevans/received_events","type":"User","site_admin":false},"created_at":"2018-09-11T07:57:52Z","updated_at":"2018-09-11T07:57:52Z","author_association":"CONTRIBUTOR","body":"If you add `smartypants: false` to the `_config.yml` file then the issue goes away.\r\n\r\n```yaml\r\nmarked:\r\n  autolink: false\r\n  smartypants: false\r\n```\r\n\r\n![bingo](https://user-images.githubusercontent.com/1855109/45345961-c4253380-b59f-11e8-8a13-2cb62d9897c8.png)\r\n\r\nHowever, that's kinda nuclear: it turns off [SmartyPants](https://daringfireball.net/projects/smartypants/) processing _for the entire site._\r\n\r\n> _\"[SmartyPants] easily translates plain ASCII punctuation characters into “smart” typographic punctuation HTML entities.\"_\r\n>\r\n> SmartyPants can perform the following transformations:\r\n>\r\n> * Straight quotes ( \" and ' ) into “curly” quote HTML entities\r\n> * Backticks-style quotes (``like this'') into “curly” quote HTML entities\r\n> * Dashes (“--” and “---”) into en- and em-dash entities\r\n> * Three consecutive dots (“...”) into an ellipsis entity\r\n\r\nI dunno that there's all that many occurrences of the above markdown that is transformed by SmartyPants; I know that I've been explicitly adding `&mdash;` and `&hellips;` to the source code on the odd occasion that I needed them. (I didn't know that SmartyPants was even a thing.)\r\n\r\nThere's the tactical approach where SmartyPants is turned off which is appealing because it can be done right now and stops users possibly getting confused. Downside is that the sweet typography goes away... which I'm not sure is all that big a deal when compared to removing a source of possible confusion.\r\n\r\nThen there's the strategic approach which is to keep SmartyPants turned on but sort out why it's FoJangledZor in the `note` blocks.\r\n\r\nThoughts?\r\n\r\n> _Random Guy On The Internet_ votes for the tactical approach to be merged in but for the ticket to remain open.\r\n\r\n😄 \r\n"}}
{"actor":{"display_login":"richdouglasevans"}}