Skip to content

Conversation

@SimonCropp
Copy link
Contributor

since they negatively effect readability and add no value

@SimonCropp
Copy link
Contributor Author

@StefanOssendorf want me to handle the conflicts?

@StefanOssendorf
Copy link
Contributor

Why do they negatively affect readability?

I'm personally for full comments here. Especially with public types.
This PR also disables these warnings. So instead of removing we should fill them out correctly.

@rockfordlhotka
Copy link
Member

While I would prefer completing the comments, I am ok with removing empty comment blocks.

I do NOT want to disable warnings about comments, because comments should exist - especially for public APIs.

I have a local branch where I've been working on automatic creation of docs as part of the build. In the past people have volunteered to create the docs, but that should be part of the GitHub pipeline.

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.

3 participants