Message ID | 20250120015603.1980991-1-sandals@crustytoothpaste.net (mailing list archive) |
---|---|
Headers | show |
Series | Convert AsciiDoc files to .adoc extension | expand |
On 2025-01-20 01:55, brian m. carlson wrote: > As mentioned in a recent thread, our use of the .txt extension for > AsciiDoc files prevents most editors from recognizing these files as > AsciiDoc automatically. There isn't an editor-independent way to > override this, so many contributors miss out on syntax highlighting, > linting functionality, and other editor niceties unless they manually > override the detection when editing. > > In addition, many forges produce rich (HTML) renderings of AsciiDoc and > other text formats automatically, but this doesn't happen with plain > .txt files. Fantastic. New contributors often start with documentation changes. Let's make it as easy as we can for them.
On Sun, Jan 19, 2025 at 8:56 PM brian m. carlson <sandals@crustytoothpaste.net> wrote: > > [snip] > > I found that using `git log -p --word-diff --word-diff-regex=.` produced > the nicest rendering of the large patch, so I would recommend that to > reviewers. > [off topic] It's a small thing, but I've started including a "Best-viewed-with: <git diff options>" trailer in commits where I think it's relevant. Now I wonder about including a configuration option to automatically apply such options (though safety + alerting someone to this change in how the diff is presented would be an interesting UI factor).