"M. Levinson" <[EMAIL PROTECTED]> writes: > Good question. I formatted it to resemble output from the pydoc program > (and the interactive Python interpreter's help system) so it would have > the look of other Python API documentation that should be familiar to > many Python programmers; installing it as-is may be suitable for that > target audience. But if it would be preferable to conform to the look of > the rest of the ELinks docs then perhaps I should rework doc/python.txt > (and contrib/python/elinks_maint.py) to use AsciiDoc markup instead?
I think convenience for users is more important here than consistent look. I often view documentation in one Emacs window while writing code in another. If the documentation is in HTML then this is not so easy to do; on the other hand, we can assume that readers of this documentation have ELinks and so can use elinks -dump. An advantage of HTML is that it supports links that lead directly to the correct place without searching; but python.txt is currently so short that there's no real need. HTML and other structured formats also look better when printed; but personally I prefer reading from the screen. I would thus be inclined to install the file as is, at least until users request a different format.
pgprqSCj3xFuY.pgp
Description: PGP signature
_______________________________________________ elinks-dev mailing list [email protected] http://linuxfromscratch.org/mailman/listinfo/elinks-dev
