python-igraph icon indicating copy to clipboard operation
python-igraph copied to clipboard

Improvement of Readme.md #726

Open CrypticRevenger opened this issue 2 years ago • 3 comments

PR no :- #726

CrypticRevenger avatar Oct 27 '23 09:10 CrypticRevenger

@ntamas Can you please review my PR. Thank you.

CrypticRevenger avatar Oct 27 '23 09:10 CrypticRevenger

Apologies if this comes across a little rude, but these changes look like ChatGPT. Did you use it for this @CrypticRevenger?

iosonofabio avatar Oct 27 '23 11:10 iosonofabio

From my perspective, it isn't a problem if it was or wasn't done with ChatGPT ... The issue here is that most of these changes simply rephrase sentences without improving them. There are a large number of changes and it's difficult to go through all of them. I do not agree with some of the new phrasings. For example, I do not agree igraph's "primary aim is to be as powerful and fast as possible".

I do not make the decision about merging this, but my recommendation is not to.

My suggestion to you is to identify specific problems, make it clear what they are, and fix only those problems. There are many, many functions whose documentation needs substantial improvements. If you'd like to contribute by writing, I suggest starting with the docs of specific functions, make sure the description is clear, complete, yet concise, and up to date with the docs of the underlying C function.

szhorvat avatar Oct 27 '23 11:10 szhorvat