shr-copy-url: arg misnamed?

shr-copy-url: arg misnamed?

[T.V Raman]

Should the arg in this function be renamed?

The name "url" is confusing, and is likely being shadowed 
(defun shr-copy-url (url)
  "Copy the URL under point to the kill ring.
If IMAGE-URL (the prefix) is non-nil, or there is no link under
point, but there is an image under point then copy the URL of the
image under point instead."
  (interactive (list (shr-url-at-point current-prefix-arg)))
  (if (not url)
      (message "No URL under point")
    (setq url (url-encode-url url))
    (kill-new url)
    (message "Copied %s" url)))
-- 

-- 

Re: shr-copy-url: arg misnamed?

[Noam Postavsky]

On Sat, 22 Sep 2018 at 12:22, T.V Raman <raman@google.com> wrote:
>
> Should the arg in this function be renamed?
>
> The name "url" is confusing, and is likely being shadowed

Not sure what you mean by shadowed, but the docstring has a copy-paste
mistake: it should say "with a prefix argument" instead of referencing
IMAGE-URL (which is an arg of shr-url-at-point).

Re: shr-copy-url: arg misnamed?

[T.V Raman]

Noam Postavsky <npostavs@gmail.com> writes:
What I meant was:

Interactive form returns "url" to fill-in its arg (url) --- agree re the
cut-and-paste error.
Not sure why I typed "shadowed" -- what I meant was that the naming of
"url" is confusing 
(interactive (list (shr-url-at-point current-prefix-arg)))
> On Sat, 22 Sep 2018 at 12:22, T.V Raman <raman@google.com> wrote:
>>
>> Should the arg in this function be renamed?
>>
>> The name "url" is confusing, and is likely being shadowed
>
> Not sure what you mean by shadowed, but the docstring has a copy-paste
> mistake: it should say "with a prefix argument" instead of referencing
> IMAGE-URL (which is an arg of shr-url-at-point).

-- 

Re: shr-copy-url: arg misnamed?

[Noam Postavsky]

On Sun, 23 Sep 2018 at 19:45, T.V Raman <raman@google.com> wrote:

> Interactive form returns "url" to fill-in its arg (url)

Not sure why that's a problem. Generally, pretty much all Emacs
functions which operate on a URL name their argument "url". It seems
like the most obvious and simplest name.

Re: shr-copy-url: arg misnamed?

[Andreas Schwab]

On Sep 23 2018, "T.V Raman" <raman@google.com> wrote:

> Noam Postavsky <npostavs@gmail.com> writes:
> What I meant was:
>
> Interactive form returns "url" to fill-in its arg (url) --- agree re the

The interactive form returns nothing, and it doesn't even reference url.

Andreas.

-- 
Andreas Schwab, SUSE Labs, schwab@suse.de
GPG Key fingerprint = 0196 BAD8 1CE9 1970 F4BE  1748 E4D4 88E3 0EEA B9D7
"And now for something completely different."

Re: shr-copy-url: arg misnamed?

[T.V Raman]

Andreas Schwab <schwab@suse.de> writes:

Yes. url here is misnamed -- should be called prefix.

Basically if you read the doc and the function signature,  you're likely to call it with a url string.> On Sep 23 2018, "T.V Raman" <raman@google.com> wrote:
>
>> Noam Postavsky <npostavs@gmail.com> writes:
>> What I meant was:
>>
>> Interactive form returns "url" to fill-in its arg (url) --- agree re the
>
> The interactive form returns nothing, and it doesn't even reference url.
>
> Andreas.

-- 

Re: shr-copy-url: arg misnamed?

[Noam Postavsky]

On Tue, 25 Sep 2018 at 09:55, T.V Raman <raman@google.com> wrote:
>
> Yes. url here is misnamed -- should be called prefix.

No, I don't think so.

> Basically if you read the doc and the function signature,  you're likely to call it with a url string.

That is the correct way to call it.

Re: shr-copy-url: arg misnamed?

[Stefan Monnier]

> Should the arg in this function be renamed?

Any suggestion?

> The name "url" is confusing,

I don't see why.

> and is likely being shadowed 

I don't see that either, sorry.


        Stefan