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

Do not expose the fields of the clients #28

Merged
merged 1 commit into from
Jul 5, 2023
Merged

Conversation

mdumandag
Copy link
Contributor

We should keep the public API surface as minimal as possible.
I don't see the benefit of making the configuration related
fields of the client public. Hence, I converted all of them
to protected fields.

I have also updated the README in couple of places. I have removed
the part where we mention you could have per-command-formatting
configuration: It is a pretty bad idea to allow mutable state
on the client object.

@burak-upstash
Copy link
Collaborator

#26 is merged, this pr can be rebased

@mdumandag
Copy link
Contributor Author

I will do it after merging the mypy pr, as this depends on that as well

We should keep the public API surface as minimal as possible.
I don't see the benefit of making the configuration related
fields of the client public. Hence, I converted all of them
to protected fields.

I have also updated the README in couple of places. I have removed
the part where we mention you could have per-command-formatting
configuration: It is a pretty bad idea to allow mutable state
on the client object.
@burak-upstash burak-upstash merged commit b260063 into main Jul 5, 2023
1 check passed
@burak-upstash burak-upstash deleted the public-fields branch July 5, 2023 13:14
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.

2 participants