[MERGE] [1.0] Move material out of User Guide into User Reference

John Arbash Meinel john at arbash-meinel.com
Mon Dec 10 15:24:21 GMT 2007


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Alexander Belchenko wrote:
> Aaron Bentley пишет:
>> And I fear that we're introducing too many ReST-isms into what's
>> supposed to be plaintext docs.  The headings are fine, but the links are
>> a problem.  I don't think Bazaar users should be forced to interpret
>> "See also `Using Hooks <../user-guide/index.html#using-hooks>`_." when
>> they run "bzr help hooks"
> 
> I personally agree with last comment. I just thinking that we can
> improve it later, because Ian want to merge it to 1.0, and next rc is
> very close.
> 
> 

I agree, though ReST is designed such that you can do:

See also `Using Hooks`_.

.. _Using Hooks:../user-guide/index.html#using-hooks.


And we could simply strip all ".. " lines, since they are meant as comment/ReST
control lines. (Also we should remember that they are blocks so:

..
   vim foo

Is also a comment block (as long as we are still indented).

I'm a little leery of mixing .py files and .txt files in the source that we
distribute. I guess some people really prefer it. I personally prefer having
real python strings. But I'm not going to block putting in raw .txt since it
seems to be something people want.

John
=:->

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.7 (Darwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFHXVokJdeBCYSNAAMRAm/bAJsHUu1ToikLDIFGJHzIbS031R8W7QCfavPf
PqOwUvhcaFpOXeLfxG/a+/Y=
=dPrl
-----END PGP SIGNATURE-----



More information about the bazaar mailing list