search

ossc-db / pg_hint_plan

Extension adding support for optimizer hints in PostgreSQL
Other
715 stars 103 forks source link

Large cleanup of README file #119

Closed xzilla closed 1 year ago

xzilla commented 1 year ago

These changes include fixing a number of typos, some syntax errors in the examples, and a fair amount of wordsmithing for clarification and/or grammar improvements.

michaelpq commented 1 year ago

Thanks for the patches. Will look into that.

michaelpq commented 1 year ago

I think that it would be better to squash the two commits into a single one. From what I can see, the HTML documentation in English has not been changed to reflect the changes done in README.md. Also, could it be a bit better for readability if the README is rewritten with a limit of 80-characters per line.

Feel free to discard the last point, I am old-school :)

michaelpq commented 1 year ago

I have opened a new ticket to discuss if the HTML documentation had better be dropped in #123. I am not really a fan in maintaining a duplication of both these things. That's just time-draining.

xzilla commented 1 year ago

I don't see any issues with squashing the two commits during the merge (presuming it will be merged 🙂).

I think if you want to reformat to 80-char line limit, I wonder how that would affect the readability of the formatted tables towards the end, but I am generally indifferent about it, with my main thought being it should be part of a separate commit/patch (like a pgindent run)

michaelpq commented 1 year ago

@xzilla After changes like 49a8839 and 41ffa51. Do you still see areas that could be improved?

michaelpq commented 1 year ago

Closing for now.