From: Daniel Shahaf <d.s@daniel.shahaf.name>
To: zsh-workers@zsh.org
Subject: Re: [PATCH] Document _canonical_paths.
Date: Thu, 18 Aug 2016 16:55:23 +0000 [thread overview]
Message-ID: <20160818165523.GA25890@tarsus.local2> (raw)
In-Reply-To: <160817095330.ZM21532@torch.brasslantern.com>
Bart Schaefer wrote on Wed, Aug 17, 2016 at 09:53:30 -0700:
> On Aug 17, 4:31pm, Daniel Shahaf wrote:
> }
> } > I don't understand why you want to remove comments from the function files.
> }
> } To avoid duplication.
>
> I think of function files as source code. You wouldn't remove comments
> from the C source code just because there's a manual page, would you?
I draw a distinction between docstrings that describe the API
contract of a function and comments that document portions of the
implementation.
I wouldn't remove comments.
However, I would remove one of two duplicate copies of a docstring.
(I'd keep the copy that's in the manual's source — in our case, yodl —
and drop the other one.)
> Also manual pages are installed separately in many cases (even the zsh
> tarballs are split to separate the docs) and therefore sometimes the
> doc isn't installed at all on a given machine. It's not duplication
> when one of the copies doesn't exist ...
This argument cuts both ways: somebody might choose to install the man
pages and only a zcompile'd version of the autoloadable function.
If we really want the docstring to be present in both locations, I think
one of them should be autogenerated from the other. In the meantime,
I've gone ahead and pushed the yodl part of the patch.
Cheers,
Daniel
next prev parent reply other threads:[~2016-08-18 16:55 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-16 22:48 Daniel Shahaf
2016-08-17 6:28 ` Bart Schaefer
2016-08-17 16:31 ` Daniel Shahaf
2016-08-17 16:53 ` Bart Schaefer
2016-08-18 16:55 ` Daniel Shahaf [this message]
2016-08-19 1:09 ` Bart Schaefer
2016-08-19 15:56 ` Daniel Shahaf
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20160818165523.GA25890@tarsus.local2 \
--to=d.s@daniel.shahaf.name \
--cc=zsh-workers@zsh.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).