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

Fix documentation inconsistencies #86

Open
xxxxme opened this issue Sep 28, 2024 · 0 comments
Open

Fix documentation inconsistencies #86

xxxxme opened this issue Sep 28, 2024 · 0 comments

Comments

@xxxxme
Copy link

xxxxme commented Sep 28, 2024

In README.md, there are the following typos/inconsistencies:

  1. "Some numbers might be two large" should be "Some numbers might be too large" (lines 68 - 69)
  2. Directly under the Encoding Data heading, it states the module supports "all four encodings for data" (line 64) and "The only unimplemented encoding is ECI mode" (line 92), but later it is stated, "three of the five possible encodings have been written" (line 119) .
  3. The options for the error parameter are listed as "L, M, Q, or H; each level can correct up to 7, 15, 25, or 30 percent of the data respectively" (lines 103 - 104) but later it says, "The code below constructs a QR code with 25% error correction [...] big_code = pyqrcode.create('0987654321', error='L' " (lines 124 & 128). Either line 124 should be changed to "7%" or line 128 should be changed to "error='Q' ".
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

No branches or pull requests

1 participant