[ruby-core:75207] [Ruby trunk Bug#12321] Backticks in log output cause issues

Issue #12321 has been updated by Derek Kniffin.


Well, it's not just slack. It's anything that uses markdown. That includes Github, Stack overflow, Jekyll, PivitolTracker, Jira, and probably many other technical tools. Markdown has become a pseudo-standard, and it's used in tons of places.

If there's a good reason to keep that backtick, I will happily close this issue, and deal with it. However, my suspicion is it causes more issues than solutions.

----------------------------------------
Bug #12321: Backticks in log output cause issues
https://bugs.ruby-lang.org/issues/12321#change-58340

* Author: Derek Kniffin
* Status: Open
* Priority: Normal
* Assignee: 
* ruby -v: ruby 2.2.3p173
* Backport: 2.1: UNKNOWN, 2.2: UNKNOWN, 2.3: UNKNOWN
----------------------------------------
I would like to propose changing ruby's log output slightly. The issue I have is with output like this:

~~~
NoMethodError: undefined method `some_method' for nil:NilClass
~~~

In particular, I don't like how some_method has a backtick on the left, and a single quote on the right. I would much prefer to have single quotes on both sides.

Now, this may seem like a very knit-picky thing, but in the modern age where markdown is very widely used, this causes an issue quite often. For instance, every time I copy/paste a log snippet like that into slack, and try wrapping it in backticks, to denote that it's a code snippet, it formats it wrong.

I've tried to find a reason why ruby's output does this, but I couldn't find anything. The best guess I have is that it was a way to emulate opening and closing apostrophes, but it's a poor replacement for that. If someone else can enlighten me about the reasoning, I'd be very curious to know it.



-- 
https://bugs.ruby-lang.org/

Unsubscribe: <mailto:[e-mail]?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>