rabbitmq-dotnet-client icon indicating copy to clipboard operation
rabbitmq-dotnet-client copied to clipboard

Incorrect comments in some public member documentation

Open lukebakken opened this issue 3 years ago • 4 comments

User @domicioam noticed the following incorrect comments in #1105:

141652977-26c68741-38e0-4c48-b5fb-32cf4ab3bdb4

lukebakken avatar Nov 15 '21 15:11 lukebakken

@domicioam please understand that when we suggest opening a pull request to fix issues it is to confirm that yes, the issue is valid and that yes, we would appreciate a contribution to fix it.

lukebakken avatar Nov 15 '21 15:11 lukebakken

@domicioam please understand that when we suggest opening a pull request to fix issues it is to confirm that yes, the issue is valid and that yes, we would appreciate a contribution to fix it.

Hello Luke,

I am not sure if that was the intention. I felt like the other guy was calling me lazy for reporting it instead of fixing it. I would gladly fix the comments if I was familiar with the library, but the best I could do at the time was to report the issue.

Thanks for the heads up anyways. It is good to learn the jargon of open source projects.

Kind regards, Dom.

dominsights avatar Nov 15 '21 15:11 dominsights

I am not sure if that was the intention. I felt like the other guy was calling me lazy for reporting it instead of fixing it.

I am certain that @michaelklishin's intention is to suggest contributing to the library, not suggest anyone is lazy. The RabbitMQ core team (I'm part of it) receives many issue reports across a large number of repositories here on GitHub. A fraction of those (like yours) are legitimate and we suggest opening pull requests in case people are hesitant to do so. If an issue doesn't require a fix we say so as well.

In general, open-source project maintainers may seem abrupt with their comments but it's best to take them at face value rather than reading into them. We're all busy with our day jobs!

lukebakken avatar Nov 15 '21 16:11 lukebakken

@domicioam I did not imply that anyone is lazy. It's a perfectly common thing to suggest for a maintainer: if the problem is well understood, the reporter might as well submit a PR.

michaelklishin avatar Nov 16 '21 08:11 michaelklishin

These particular XML comments appear to be correct in main.

lukebakken avatar Jun 03 '24 17:06 lukebakken