Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Declare the etaoin public API #441

Merged
merged 1 commit into from
May 25, 2022

Conversation

lread
Copy link
Collaborator

@lread lread commented May 25, 2022

Clearly declaring a public API allows us to freely change what is
internal and invest our effort in being careful to not break what is
public.

We've asked the Etaoin community if we've got this right, but no peep
yet. I'm sure we'll hear plenty of peeps if we've got it wrong when
folks actually start using the next release. If so, we can adjust as
necessary.

Moved what namespaces are deemed internal to impl namespaces and marked
with :no-doc metadata.

See #430 for details.

Closes #430

Clearly declaring a public API allows us to freely change what is
internal and invest our effort in being careful to not break what is
public.

We've asked the Etaoin community if we've got this right, but no peep
yet. I'm sure we'll hear plenty of peeps if we've got it wrong when
folks actually start using the next release. If so, we can adjust as
necessary.

Moved what namespaces are deemed internal to impl namespaces and marked
with `:no-doc` metadata.

See clj-commons#430 for details.

Closes clj-commons#430
@lread lread requested review from borkdude and slipset as code owners May 25, 2022 00:56
@lread lread merged commit e1b7df6 into clj-commons:master May 25, 2022
@lread lread mentioned this pull request Jun 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: What is the supported public API?
1 participant