Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Large cleanup of README file #119

Closed
wants to merge 2 commits into from
Closed

Large cleanup of README file #119

wants to merge 2 commits into from

Conversation

xzilla
Copy link
Contributor

@xzilla xzilla commented Jan 24, 2023

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.

These changes include fixing a number of typos, some syntax errors in the examples, and wordsmithing for clarification and/or grammar improvements.
@michaelpq
Copy link
Collaborator

Thanks for the patches. Will look into that.

@michaelpq
Copy link
Collaborator

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
Copy link
Collaborator

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
Copy link
Contributor Author

xzilla commented Feb 11, 2023

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
Copy link
Collaborator

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

@michaelpq
Copy link
Collaborator

Closing for now.

@michaelpq michaelpq closed this Apr 19, 2023
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.

2 participants