google / gitiles

A simple browser for Git repositories.
https://gerrit.googlesource.com/gitiles/
Other
582 stars 174 forks source link

Double dash "--" is incorrectly changed to a hyphen &ndash #71

Open spearce opened 7 years ago

spearce commented 7 years ago

Originally reported on Google Code with ID 77

Mark down file in gtiles with a **--text** (may require this in a header) results in
a &ndash being output, instead of "--", which breaks searching for that text.

Ex:
https://code.google.com/p/chromium/codesearch#chromium/src/tools/gn/docs/reference.md
"## **--args**: Specifies build arguments overrides."

Produces:
https://chromium.googlesource.com/chromium/src/+/master/tools/gn/docs/reference.md
"–args: Specifies build arguments overrides."

But I expect:
"--args: Specifies build arguments overrides."

Reported by None on 2015-04-28 13:35:31

spearce commented 7 years ago
Mark down file in gtiles with a **--text** (may require this in a header) results in
a &ndash being output, instead of "--", which breaks searching for that text.

Ex:
https://code.google.com/p/chromium/codesearch#chromium/src/tools/gn/docs/reference.md
"## **--args**: Specifies build arguments overrides."

Produces:
https://chromium.googlesource.com/chromium/src/+/master/tools/gn/docs/reference.md
"–args: Specifies build arguments overrides."

But I expect:
"--args: Specifies build arguments overrides."

Reported by None on 2015-04-28 13:35:31

spearce commented 7 years ago
It's possible I might be able to work around this by escaping the dashes, e.g., \--
or some such. I'll do some testing to find out.

Reported by None on 2015-04-28 15:19:15

spearce commented 7 years ago
Yes, but the double dash transformation appears to be an undesired markdown
transformation? I don't see that in spec anywhere, and it seems to be a
destructive presentation formatting change.

Reported by None on 2015-04-28 15:25:45

spearce commented 7 years ago
there is a lot of variation in markdown specs and implementations, and I believe there
are a number of implementations that do automatically turn -- into –

Which isn't to say this is a bug, just that it's not a particularly surprising one
if it is, and it would be understandable if it was the default behavior and considered
not a bug (at least, for non-code blocks).

Reported by None on 2015-04-28 15:32:42

spearce commented 7 years ago
It does look like escaping (at least) the first dash will disable the &ndashing.

Reported by None on 2015-06-20 22:01:23