carbon-lang icon indicating copy to clipboard operation
carbon-lang copied to clipboard

Update Readme.md

Open gautam1858 opened this issue 3 years ago • 3 comments

Refactoring the documentation for better readablity

gautam1858 avatar Jul 28 '22 13:07 gautam1858

I'm going to leave this to @chandlerc to decide if he wants these changes. Many of them look like they're more subjective improvements. The top-level README is high visibility, and there's already been a lot of review of the phrasing, so I do think subjective changes are more likely to be declined.

jonmeow avatar Jul 28 '22 19:07 jonmeow

I want to echo some points Jon makes: this is an incredibly high visibility document, and has already had a huge amount of review. I'm quite hesitant to change it's wording without a very clear motivation.

If some of these are just very narrow grammar but fixes, maybe extract those and identify them as such?

For most of what i saw when skimming it looks like they are just alternate ways of phrasing things. I think we would need to really understand the specific problem being addressed before we dig into these. A purely preferential change I think doesn't make sense.

chandlerc avatar Jul 29 '22 09:07 chandlerc

You are absolutely right. I don't want to justify those but it's just more readable.

Let me contribute more on the coding part.

gautam1858 avatar Jul 29 '22 09:07 gautam1858

It sounds like there's agreement the changes are being retracted in response to chandlerc's comment. I'm closing this PR in order to remove it from the open PR list.

jonmeow avatar Aug 02 '22 20:08 jonmeow