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

Add type hints to improve codebase readability and enable static type checking #203

Open
Niraj-Kamdar opened this issue Jun 28, 2023 · 7 comments
Labels
help wanted Please contribute to close this issue

Comments

@Niraj-Kamdar
Copy link

I propose adding type hints to the mocket Python package to enhance code readability and maintainability. Type hints provide several benefits, including improved developer productivity, enhanced code documentation, and the ability to catch potential errors using static type-checking tools like Mypy.

@mindflayer
Copy link
Owner

mindflayer commented Jul 1, 2023

Hi @Niraj-Kamdar, I am not sure if I got your proposal right. Are you volunteering to add type hints to the project?

@mindflayer
Copy link
Owner

No answers to my question, closing it.

@mindflayer mindflayer closed this as not planned Won't fix, can't repro, duplicate, stale Jul 6, 2023
@Niraj-Kamdar
Copy link
Author

Hey @mindflayer Sorry for the late reply here. My proposal is for adding type hints in general, I would love to help here though when I get free time but currently, I have too much on my plate to help out with this. I would appreciate if you can keep this issue open so others or me can eventually take this and add type-hints to the mocket.

@Kilo59
Copy link
Contributor

Kilo59 commented Apr 25, 2024

@mindflayer Closing this issue signals that

  1. You don't plan to add type annotations.
  2. You aren't willing to accept contributions that add these.

Can you re-open this issue if one or both of these are untrue?

@mindflayer
Copy link
Owner

mindflayer commented Apr 25, 2024

@mindflayer Closing this issue signals that

1. You don't plan to add type annotations.

2. You aren't willing to accept contributions that add these.

Can you re-open this issue if one or both of these are untrue?

I am the only maintainer of Mocket, and I think it's worth keeping non-bug issues open only if I am confident it's something I have time for, or at least if I know someone is willing to help with.
Having a backlog of stuff just for the sake of it it's pointless.
So, allow me to bounce back the question: is anyone willing to contribute with adding type hints?

@Kilo59
Copy link
Contributor

Kilo59 commented Apr 25, 2024

So, allow me to bounce back the question: is anyone willing to contribute with adding type hints?

@mindflayer

Yes. The only thing that gives me pause about taking on this work is the fact that this issue was closed. Which makes it ambiguous as to whether an annotation PR would be accepted.

@mindflayer mindflayer reopened this Apr 26, 2024
@mindflayer
Copy link
Owner

Well, alright then! 👍

@mindflayer mindflayer added the help wanted Please contribute to close this issue label Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Please contribute to close this issue
Projects
None yet
Development

No branches or pull requests

3 participants