On 1/22/19 2:37 PM, Peng Yu wrote: >> That's a documentation convention - the all-caps in the docstring calls >> your attention to the need to search case-insensitively for the actual >> variable, while spelling it case-sensitively would make it blend into >> the sentence and make it harder to realize that the sentence is indeed >> pointing you to an external variable. > > Why not just use ` to quote it literally? Given that markdown is very > common nowadays. Quoting it with ` should be a better choice rather > than making it capitalized. I guess this probably because the original > codebase predates markdown and its variants?
By MANY years ;) > >> If you think the existing convention is confusing, then submit a patch >> to change it instead of asking someone else to take on the grunt work. >> Otherwise, learn to live with the existing convention (which doesn't >> bother me, so I won't be submitting a patch). > > If it was hosted on github, then I would. But I am not used to > savannah. Personally, I don't think it is as convenient. You fail to understand the power of distributed version control. Nothing is preventing you from creating a github clone of the savannah upstream git repository, and making your patches in whatever way you prefer using github's processes; the only real leap is realizing that you submit your patches as emails to this list rather than as pull requests to github. -- Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3226 Virtualization: qemu.org | libvirt.org
signature.asc
Description: OpenPGP digital signature
