url icon indicating copy to clipboard operation
url copied to clipboard

Check Help Card against actual declaration

Open vinniefalco opened this issue 3 years ago • 8 comments

The contents of the Help Card need to be checked against the url and url_view declarations to ensure that the members are accurate.

vinniefalco avatar Jul 27 '22 23:07 vinniefalco

I went through the help card and:

  • set_scheme_id should be removed (when did that happen? is that on purpose?)
  • ipv_future should become ipvfuture or vice-versa. Which one do we want?

Is that correct?

alandefreitas avatar Aug 12 '22 03:08 alandefreitas

I guessed set_scheme_id but I was wrong, it is set_scheme with 2 overloads. But I wonder if we should rename it... the docs kind of suffer a little bit because of it. set_scheme_id is more discoverable.

ipvfuture is correct.

vinniefalco avatar Aug 12 '22 04:08 vinniefalco

We should remove set_scheme_id, but we should open an issue to start a discussion on if we should rename it to set_scheme_id in the API. This would have to wait until after the review of course.

vinniefalco avatar Aug 12 '22 04:08 vinniefalco

I guessed set_scheme_id but I was wrong, it is set_scheme with 2 overloads.

Yes. I agree. I like set_scheme with two overloads more.

We should remove set_scheme_id, but we should open an issue to start a discussion on if we should rename it to set_scheme_id in the API. This would have to wait until after the review of course.

Sure.

alandefreitas avatar Aug 12 '22 19:08 alandefreitas

so you prefer

set_scheme( string_view )
set_scheme( scheme )

instead of

set_scheme( string_view )
set_scheme_id( scheme )

?

vinniefalco avatar Aug 12 '22 20:08 vinniefalco

Yes

alandefreitas avatar Aug 12 '22 23:08 alandefreitas

Needs another quick look just to be sure

vinniefalco avatar Sep 11 '22 23:09 vinniefalco

Yes. I've been purposefully ignoring this for now because we're changing a lot lately.

alandefreitas avatar Sep 13 '22 01:09 alandefreitas

This has been done many times since this original issue was opened.

alandefreitas avatar Jul 18 '23 18:07 alandefreitas