search

inejge / ldap3

A pure-Rust LDAP library using the Tokio stack
Apache License 2.0
220 stars 38 forks source link

General documentation issues, 0.7.x #3

Closed inejge closed 1 year ago

inejge commented 7 years ago

This is the place for genral remarks and discussion about the crate documentation. Issues for specific, localized bugs, such as typos and unclear or ambiguous wording, should be opened separately. Ideally, discussion in this issue should result in opening more targeted issues, which can then be resolved. This message will contain an overview of active sub-issues, and the title should reflect the library version(s) covered.

archaelus commented 6 years ago

One question I have about this crate that isn't obvious from the documentation at the moment is whether this library can be used as an LDAP server or proxy (i.e. I see the LDAP client support, but can't tell if there's a way to use this crate to act as an LDAP server - I am interesting in building an LDAP -> Rest API proxy and can't tell from the docs if this crate is what I'm after).

Clarifying in the documentation whether or not this crate can be or intends to be useable as an LDAP server or proxy would be helpful I think. (ps: thanks! neat crate)

inejge commented 6 years ago

@archaelus Thanks for the comment! You're right, there is no explicit mention of the fact that the library is client-only (see #5 for a brief rationale), although the README is titled "LDAP Client Library". I've opened an issue for updating the docs.

tjyang commented 1 year ago

Can this issue be closed ? See https://github.com/inejge/ldap3/blob/master/README.md#ldap-client-library

archaelus commented 1 year ago

Yep! Thanks for the documentation update.On Oct 20, 2022, at 06:02, T.J. Yang @.***> wrote: Can this issue be closed ? See https://github.com/inejge/ldap3/blob/master/README.md#ldap-client-library

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: @.***>

tjyang commented 1 year ago

I didn't do the doc update and I can't close this issue. Just a friendly reminder to close out this issue.

inejge commented 1 year ago

As noted in the opening post, this issue was meant as a general place to discuss documentation requests/issues, not specifically the one about the client/server/proxy distinction. Nevertheless, for the past five years it elicited precisely one report, which could have been opened independently, so it hasn't been very useful. I'll close it, and any documentation issues may be opened separately.