search

bensonarafat / super_tooltip

SuperTooltip It is super flexible and allows you to display ToolTips in the overlay of the screen.
https://pub.dev/packages/super_tooltip
MIT License
141 stars 95 forks source link

Code Documentation #112

Closed bensonarafat closed 6 days ago

bensonarafat commented 3 months ago

I just need the code base documented. Thanks

RotRot-pi commented 2 months ago

Hello! I'd love to take on this good first issue. Could you please provide more details on the specific areas or aspects of the codebase that need documentation to meet the expected results? Thanks!

bensonarafat commented 2 months ago

Thanks @RotRot-pi for your help The whole codebase needs comments on them. I've not had enough time to complete it for long now. But we could work on it together

RotRot-pi commented 2 months ago

Thanks @bensonarafat for the details, I'd be happy to help with commenting the codebase. Working together sounds great! How would you like to divide the work, or is there a particular section you'd like me to start with?

bensonarafat commented 2 months ago

You know how the plugin works right? You can start from here @RotRot-pi lib/src/super_tooltip.dart Any property you don't understand and why its been used let me know, so I can explain

RotRot-pi commented 2 months ago

@bensonarafat Thanks for the direction! I’ll start with lib/src/super_tooltip.dart. If I come across any properties that I don’t fully understand, I’ll reach out to you for clarification.