Den mån 19 juni 2023 kl 00:29 skrev Nathan Hartman <hartman.nat...@gmail.com
>:

> On Sat, Jun 17, 2023 at 7:33 AM Daniel Sahlberg <
> daniel.l.sahlb...@gmail.com> wrote:
>
>> Den fre 16 juni 2023 kl 09:49 skrev Osipov, Michael (SMD IT IN) via users
>> <us...@subversion.apache.org>:
>>
>>> Scratch that. My thread from five years ago is still valid:
>>> https://lists.apache.org/thread/lonftwtj2kmnjf5mlp91jyxz9xlsgv3d
>>>
>>> The issue sill persists. The doc improvement from Daniel Shahaf haven't
>>> been implemented yet.
>>>
>>
>> Moving the discussion to dev@:
>>
>> Do we want to implement the suggested doc improvement? I started testing
>> each of the commands and the @ trick is required on almost all except for
>> svn checkout so it will be a lot of changed text. Does it make sense or
>> will it only be a cause of confusion?
>>
>
>
> I think it's a good idea as it will help to make the documentation more
> clear and complete.
>

As long as the addition actually make it more clear in the general case.
(Documenting edge cases is always difficult). Does the description make
sense, also for a non-experienced user? Do we also need to document that
PEGREVSION can be empty (for URLs containing an @ character)? Maybe
URL[@[PEGREVISION]]?


> I added the explanation as a separate text to allow for some re-use but
>> the argument has many different names (PATH, WCPATH, URL ...) so it is
>> repeated a few times, maybe it can be reworded to leave out the argument
>> name?
>>
>
>
> Hmmm, it looks like we're not entirely consistent: In my mind, PATH could
> be a working copy path or a repository path, while WCPATH must be a working
> copy path. But, looking at the help strings for, e.g., 'svn add', it calls
> for a PATH; I would expect to see WCPATH... (Is there a way to schedule a
> path already in the repository for addition?)
>

Agree it seems a bit random at times, but I didn't look at it overall.

Adding a reminder that we should update the SVN book as well, it contains
what looks like a copy of the help command, eg:
https://svnbook.red-bean.com/nightly/en/svn.ref.svn.c.add.html

Kind regards,
Daniel Sahlberg

Reply via email to