Skip to content

Conversation

@rsbrooks
Copy link

Made the following updates to the main README file (docs/intro.rst) to improve readability and add missing information:

  • Changed 'Introduction' section header to 'What is wcwidth?'.
  • Reformatted 'Introduction' section and fixed minor grammatical issues.
  • Added 'Getting Started' section.
  • 'Getting Started' section includes basic API function information, links to PyPI package, links to API documentation site, Unicode environment variable config, and pip install instructions
  • Added 'Helpful Resources for Contributors' section.
  • 'Helpful Resources for Contributors' section includes instructions for making local changes to source code, updating Unicode data tables, building documentation, executing unit tests, updating requirements, and using supplemental utilities.

…lity. Updated 'Introduction' section header to 'What is wcwidth?'.
…ions to main README (docs/intro.rst). Rearranged content from existing sections, reformatted information, fixed minor grammatical errors, added missing links and info, and rewrote various segments to improve readability.
@jquast
Copy link
Owner

jquast commented Sep 18, 2025

I just want to say I appreciate the thoughtful revision, it's a bit overwhelming to see so much lightly rewritten, I get caught up about finding what changed, and choices of specific technical words from the years of developing this library make me consider why I chose it, it's hard to say after so many years.

But there are also great grammer and some good new paragraphs, just a bit of work to pick apart sorry for the delay in response

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.

3 participants