On Mar 19, 2012, at 2:24 PM, Jean-Sébastien H. wrote:
> Hi,
>
> Could you review the attached patch adding documention to the function
> ldap_control_paged_result & ldap_control_paged_result_response.
>
> Regards,
>
> NB : I'm not very familiar with doc process so correct me if I'm wrong.
Hello Jean-Sebastien,
I'm not all that familiar with LDAP but know the documentation there
is lacking. It'd be most wonderful if you chose to champion those docs.
Or, simply offering these patches is perfectly fine too. I'm going to
assume you want to get involved with the PHP documentation, in which
you'd want someone to nitpick by finding every tiny little problem with
your patches. I can do that! :) So here goes:
- Whitespace
We are strict about whitespace. A few whitespace topics worth
mentioning
- A content commit should not mix in whitespace changes (like removing
ending spaces).
- No tabs or lengthy indentation within the XML, which should be single
spaced
- No <para>foo</para>, as foo should be on its own line
- refpurpose
No periods
- Links
All links are defined within entities/globals.ent, and then linked.
Those are defined within doc-base/entities/global.ent so you'd add
new links there
- Use entities
The return value should probably used the &return.success; entity.
- Random
- In one example, I think $ds should be defined, as to allow said example
to be more copy-n-paste friendly and understandable
- PHP code should adhere to the PEAR Coding Standards, although this isn't
a major deal (but worth noting, as a general guideline)
Much of this is referenced within the FAQ so please have a look:
- https://wiki.php.net/doc/howto/faq
Phew! Hopefully that helps! Have a nice day :)
Regards,
Philip
