[MERGE] man page fixes (try again)

Olexandr Byelchenko bialix at ukr.net
Mon Mar 26 13:14:55 BST 2007


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

Ian Clatworthy пишет:
> More fixes to the help and man page generated from it. After commit this
> time. :-(

> @@ -1213,8 +1210,8 @@
>
>      If there is a repository in a parent directory of the location, then
>      the history of the branch will be stored in the repository.  Otherwise
> -    init creates a standalone branch which carries its own history in
> -    .bzr.
> +    init creates a standalone branch which carries its own history in
> +    the .bzr directory.

^-- is not it better to keep preposition 'in' together with following noun,
i.e.:

	init creates a standalone branch which carries its own history
	in the .bzr directory.

what you think?

> @@ -1928,7 +1925,7 @@
>      Root may be the top directory for tar, tgz and tbz2 formats. If none
>      is given, the top directory will be the root name of the file.
>
> -    If branch is omitted then the branch containing the CWD will be used.
> +    If branch is omitted then the branch containing the current working directory will be used.

^-- PEP-8 here. Line should not be more than 80 chars, especially if this
is docstring, printed on the screen, it should be no more than 79 chars.

> @@ -1966,7 +1963,12 @@
>
>
>  class cmd_cat(Command):
> -    """Write a file's text from a previous revision."""
> +    """Write the contents of a file as of a given revision to standard output.
> +
> +    If no revision is nominated, the last revision is used.
> +
> +    Take care to redirect standard output when using this command on a binary file.
> +    """

^-- may be add word 'Note:' before last sentence?

=== modified file tools/doc_generate/autodoc_man.py
> --- tools/doc_generate/autodoc_man.py
> +++ tools/doc_generate/autodoc_man.py
> @@ -176,7 +176,7 @@
>  .I "BZRPATH"
>  Path where
>  .B "%(bzrcmd)s"
> -is to look for external command.
> +is to look for shell plugin external commands.
>  .TP
>  .I "BZR_EMAIL"
>  E-Mail address of the user. Overrides default user config.
> @@ -198,7 +198,7 @@
>  .SH "FILES"
>  .TP
>  .I "~/.bazaar/bazaar.conf"
> -Contains the users default configuration. The section
> +Contains the user's default configuration. The section
>  .B [DEFAULT]
>  is used to define general configuration that will be applied everywhere.
>  The section

^-- I'm sure you need to make similar changes in tools/doc_generate/autodoc_rstx.py
generator.

[µ]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFGB7k/zYr338mxwCURAlBxAJ9KCQUWioT708WCVcDZmyVyeApZwACaA0+C
xJGo4bERDexA1hye+X5djqA=
=aGrG
-----END PGP SIGNATURE-----



More information about the bazaar mailing list