Conversation
0667c3e to
c074b2a
Compare
cf4e2b8 to
3ec979f
Compare
Co-authored-by: Jordi Kroon <jkroon@onyourmarks.agency>
TimWolla
left a comment
There was a problem hiding this comment.
First pass at comments. Didn't yet look at all files, but this looks like a good start. Will take another look after you reviewed my comments to avoid looking at all files twice in case they change.
| <term><parameter>context</parameter></term> | ||
| <listitem> | ||
| <simpara> | ||
| Context of the error. |
There was a problem hiding this comment.
This is pretty tautological.
| Context of the error. | |
| The input URL at the point where the error was detected. |
There was a problem hiding this comment.
Yes, documenting such a huge API is very painful, so I usually tried to rely on very basic content (it can be improved over time). But I agree, your suggestion is much better!
There was a problem hiding this comment.
so I usually tried to rely on very basic content (it can be improved over time)
Absolutely. I'm happy to get this merged when the obvious mistakes (e.g. example code is there, but the output is still a placeholder) are fixed and will then go through the rendered version to propose better explanations.
| <member><methodname>Uri\Rfc3986\Uri::getUsername</methodname></member> | ||
| <member><methodname>Uri\Rfc3986\Uri::getRawUsername</methodname></member> | ||
| <member><methodname>Uri\WhatWg\Url::getUsername</methodname></member> |
There was a problem hiding this comment.
I don't think the RFC 3986 getters are appropriate "see also" for this method.
| <member><methodname>Uri\Rfc3986\Uri::getUsername</methodname></member> | |
| <member><methodname>Uri\Rfc3986\Uri::getRawUsername</methodname></member> | |
| <member><methodname>Uri\WhatWg\Url::getUsername</methodname></member> | |
| <member><methodname>Uri\WhatWg\Url::getUsername</methodname></member> | |
| <member><methodname>Uri\Rfc3986\Uri::withUserinfo</methodname></member> |
| <member><methodname>Uri\Rfc3986\Uri::withScheme</methodname></member> | ||
| <member><methodname>Uri\WhatWg\Url::getScheme</methodname></member> |
There was a problem hiding this comment.
Prefer references of the same class first (same for the others).
| <member><methodname>Uri\Rfc3986\Uri::withScheme</methodname></member> | |
| <member><methodname>Uri\WhatWg\Url::getScheme</methodname></member> | |
| <member><methodname>Uri\WhatWg\Url::getScheme</methodname></member> | |
| <member><methodname>Uri\Rfc3986\Uri::withScheme</methodname></member> |
| <refsect1 role="seealso"> | ||
| &reftitle.seealso; | ||
| <simplelist> | ||
| <member><methodname>Uri\Rfc3986\Uri::getUserInfo</methodname></member> |
There was a problem hiding this comment.
It should reference withUserInfo: For the same class the getters should be listed, for the other class, the corresponding with-er should be lsited.
| &example.outputs; | ||
| <screen> | ||
| <![CDATA[ | ||
| Code example |
| <simpara> | ||
| Description. | ||
| </simpara> |
There was a problem hiding this comment.
I didn't have a good idea what kind of description I should write in the examples. Do you have a good suggestion?
There was a problem hiding this comment.
The description for the example can just be dropped if you have nothing useful to say.
| <simpara> | |
| Description. | |
| </simpara> |
There was a problem hiding this comment.
Ah yes, that makes sense
| <refsect1 role="seealso"> | ||
| &reftitle.seealso; | ||
| <simplelist> | ||
| <member><methodname>Uri\Rfc3986\Uri::resolve</methodname></member> |
There was a problem hiding this comment.
I think listing the contructor / parse method here is appropriate.
| </methodsynopsis> | ||
| &warn.undocumented.func; | ||
| <simpara> | ||
| Description. |
Another attempt to document ext/uri after #5060
Some of my sentences are very clunky, so I am happy to receive suggestions.