Frequently Asked Questions¶
Isn’t this an overly elaborate solution for a simple problem?¶
Perhaps. However, it Works For Me™.
You’re obviously free to use what works for you, be that manually updating the
information in your editor or using a simpler approach such as shtool‘s
version
applet.
I give perl
scripts the suffix .perl
, can I make type guessing work?¶
Yes. The simple way is to just create a symlink from pl.jinja
to
perl.jinja
.
Do you accept template contributions?¶
Yes, if they are somewhat general. And, it is a great way to have me maintain template compatibility for you in case something changes in a future version.
I don’t like your choice of template language¶
[It isn’t really a question, but it has come up a couple of times.]
The use of Jinja should only be an issue if you wish to author your own templates, if you’re using the built-in templates you shouldn’t notice Jinja at all. That said...
The use of Jinja seems to be a barrier to entry for a couple of people, but it isn’t going to change. For the same – invariably pointless and religious – reasons people prefer other templating engines I prefer Jinja.
How do I add version data to my project’s README
?¶
The way I manage it, using versionah
, is by having a custom template for such a project.
The only requirement versionah
has is that {{ magic }}
is included in the
template, so you can use a project specific template that includes your full
README
data and generate the distributed README
from that.
Consider it the README.in
approach you’ve probably used with GNU
autotools and it makes perfect sense.
Will you support other version formats?¶
If the patches you submit for other version formats aren’t too invasive then they’ll probably be accepted. If you’re going to propose such a patch open an issue or drop me a mail first, so it can be discussed.
If the format you’re going to implement looks like the LooseVersion
format
defined in PEP 386 with support for random words or odd characters then the
answer is likely to be a resounding “no”. Direct support for the full
StrictVersion
format defined in that PEP will, however, likely be accepted
with open arms.