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

Adding documentation on methods and attributes. #17

Closed

Conversation

hiuryoliveira
Copy link

Hello my friend.
I would like to congratulate you on the great work with this plugin. I would like to add some feature issues, and patterns that would be important in the use of my project.

My first contribution is adding documentation for methods and attributes.

@pelmered
Copy link
Owner

Thank you @hiuryoliveira!
I'm normally not a fan of comments on all the methods and attributes as I think mostly just adds noise and clutter, and with type hints and good naming of the methods I find that they add little value. However, in an open source package like this one it might add some more value.

I'm willing to merge if you can make a good case for this.

@hiuryoliveira
Copy link
Author

hiuryoliveira commented Mar 24, 2024

@pelmered, I reflected a little more on what you told me, and I have to agree. But what do you think if we add declare(strict_types=1) ?

@pelmered
Copy link
Owner

@hiuryoliveira Yes, strict types would be nice. I would accept an PR for that if it does not break anything.

@pelmered pelmered closed this Mar 26, 2024
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