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

Use consistent code comments #109

Closed
orhun opened this issue Oct 10, 2023 · 6 comments
Closed

Use consistent code comments #109

orhun opened this issue Oct 10, 2023 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@orhun
Copy link
Owner

orhun commented Oct 10, 2023

Is your feature request related to a problem? Please describe.

Java-like code commenting is used throughout the codebase but there are still places where this doesn't apply.

Describe the solution you'd like

Use rustdoc friendly code comments.

Describe alternatives you've considered

None.

Additional context

None.

@orhun orhun added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Oct 10, 2023
@orhun orhun self-assigned this Oct 10, 2023
@Muhammad-Owais-Warsi
Copy link
Contributor

So basically we just have to switch the way comments are written in the codebase i.e. from /* */ to /// or //! as mentioned on the https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html

@orhun
Copy link
Owner Author

orhun commented Oct 6, 2024

Yup, correct!

@orhun orhun removed their assignment Oct 6, 2024
@Muhammad-Owais-Warsi
Copy link
Contributor

I would love to help with this issue. Just to confirm, do I need to change the style of comments as written in this file: https://github.com/orhun/kmon/blob/master/src/widgets.rs

@orhun
Copy link
Owner Author

orhun commented Oct 6, 2024

Yes. I assigned the issue to you, let me know if there are any additional questions :)

@Muhammad-Owais-Warsi
Copy link
Contributor

Yes. I assigned the issue to you, let me know if there are any additional questions :)

Thanks, I'll let you know if any..

@Muhammad-Owais-Warsi
Copy link
Contributor

#174

@orhun orhun closed this as completed Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants