{"push_id":789032309,"size":2,"distinct_size":2,"ref":"refs/heads/corrections3","head":"eca59aad1700526f4ece1f839aadd5455880fd47","before":"a3396e1456d0f4d05ad0033108c53a0114c0b539","commits":[{"sha":"ed5671b4f8c44581d1b0e472196903bbc7452655","author":{"email":"f9231051ec6817d2d71487989ea7bb561d7f7c32@users.noreply.github.com","name":"eksperimental"},"message":"Standardize use of backticks and quotes; including Error messages and Title Case commands\n\nThis is a large commit that does the following:\n* Removes backticks from messages and comments.\n  All references to backticks have been replaced with double quotes everywhere the\n  code is not interpreted as Markdown, (ie. anywhere outside documentation and\n  markdown files, such as in code comments, or error messages).\n\n* Variables in Exception messages are printed using `inspect`\n  The way no-matching error message are printed, have changed because now we use inspect for printing\n  variables. The following file and their respective test have been changed:\n  - lib/elixir/lib/exception.ex\n  - lib/elixir/lib/inspect/algebra.ex\n  - lib/elixir/test/elixir/inspect_test.exs\n  - lib/ex_unit/test/ex_unit/formatter_test.exs\n  - lib/elixir/test/elixir/exception_test.exs\n\n* Properly use Title Case for Mix, Git, Dializer\n\n* Use backticks when citing a command\n\n****************************************************\nCONVENTION FOR RENAMING USING BACKTICKS AND QUOTES\n\nhttps://github.com/elixir-lang/elixir/pull/3697#issuecomment-138811747\n\n1. Backticks should never be printed in error messages, neither be included anywhere where Markdown code is not interpreted as such.\n\n2. Do not use single quotes anywhere. We should favor double quotes everywhere, to avoid confusion\n\n3. If you want to format something in error messages, use inspect. For example, if you want to show the dependency name and that is an atom, instead of the dependency \"foo\", let's show the dependency :foo. Less noise and may click better\n\n4. Similarly, if you want to show something with double quotes, call inspect, as it handles escaping as well as the quotes\n\n5. Things like \"--all\" just add verbosity, we can definitely read --all without ambiguity.\n\n6. When using switches with a single hyphen (such as \"-o\"), we can make it explicit in the text: e.g. \"... give the switch -o when choosing ...\"\n\n****************************************************\nSHELL COMMANDS TO DETECT CODE BREAKING THE RULES\n\n* Detect values surrounded by single-quotes where we want double-quotes.\n\n    # regular variables\n    ag \"'#{\"\n    # constants or ENV variables\n    ag \"'[A-Z][A-Z0-9_-]+\"\n    # switches\n    ag -i \"(?<!(\\[))'--?[a-z0-9][a-z0-9_-]+'\"\n    # atoms\n    ag -i \"(?<!(\\[))':[a-z0-9][a-z0-9_-]+'\"\n\n    # DETECT BACKTICKS OUTSIDE DOCS\n    ag \"^\\s+(?<!(#))#[^#\\r\\n]*\\`\" --ignore \"*.md\"\n    ag '^\\s+[\"%].*`' --ignore \"*.md\"\n    ag -s '(raise|Error)\\b(?!(`|/)).*\\`'\n\n* Spot mentions to running a command that is not using backticks:\n\n    commands=\"elixir|elixirc|mix|iex|ex_doc|git|make|rebar|dialyzer|erl|rm|cd|mkdir|rmdir|ln|ls|pwd\"\n    actions=\"runs?|running|executes?|executing|types?|typing|enters?|entering|calls?|calling\"\n    ag '(?i)('${actions}')(?-i)\\b[^`\\r\\n/]+[\\ \\t]+(?!(`))('${commands}')'\n    ag '(?-i)\\b(?!(`))('${commands}')[\\ \\t]+[^`\\r\\n/]+(?i)(commands?)'\n\n* Spot where a command is mentioned:\n\n    #commands=\"erlang|elixir|eex|iex|ex_unit|ex_doc|logger|elixirc|git|make|rebar|dialyzer|erl|rm|cd|mkdir|rmdir|ln|ls|pwd\"\n    commands=\"mix|elixirc|git|make|rebar|dialyzer|erl|rm|cd|mkdir|rmdir|ln|ls|pwd\"\n    ag -s '(?<!(\\`))(?<!(\\.))(?<!(/))(?<!(:))(?<!(_))\\b('${commands}')\\b(?!(:))(?!(\\?))(?!(_))(?!(-))(?!(\\.))(?!(\\`))(?!(/))(?!(>))' \\\n    --ignore \"*.erl\" --ignore \"*.yrl\" --ignore \"*.src\"","distinct":true,"url":"https://api.github.com/repos/eksperimental/elixir/commits/ed5671b4f8c44581d1b0e472196903bbc7452655"},{"sha":"eca59aad1700526f4ece1f839aadd5455880fd47","author":{"email":"f9231051ec6817d2d71487989ea7bb561d7f7c32@users.noreply.github.com","name":"eksperimental"},"message":"Fix bugs involving Markdown code\n\nFix common mistakes like the random backtick hanging in the wrong place,\nor the wrongly formatted link, or single-quotes instead of backtick.\n\nCommands to detect these common mistakes:\n        ## COMMON MISTAKES\n        # single backtick in html docs\n        ag '`' ./doc --ignore \"*.css\" --ignore \"*.js\"\n        # links in the wrong format\n        ag '\\[\\w+://[^)\\] ]+\\]'\n        ag '\\(\\w+://[^)\\] ]+\\]'\n        ag '\\[\\w+://[^)\\] ]+\\)'\n        # find html code like: [\"Strictly Pretty\" (2000) by Christian Lindig][0]</p>\n        ag '\\[[^\\]]+\\](\\(|\\[)' doc/ --ignore \"*.js\"","distinct":true,"url":"https://api.github.com/repos/eksperimental/elixir/commits/eca59aad1700526f4ece1f839aadd5455880fd47"}]}