maxcountryman / maxcountryman/flask-bcrypt
Inconsistency between readthedocs and Github Readme
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 327
- Forks
- 65
- PR merge metrics
- No merged PRs in 30d
Description
Hi,
there is a small inconsistency between the README in this repo and the documentation on readthedocs.io. The compiled version for 1.0.1 includes the following section under "Usage", which is not found here:
In Python 3, you need to use decode(‘utf-8’) on generate_password_hash(), like below:
pw_hash = bcrypt.generate_password_hash(‘hunter2’).decode(‘utf-8’)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the repository README's Usage section with the compiled 1.0.1 documentation on readthedocs.io, focusing on the Python 3 generate_password_hash example described in the issue. Update the README so the two sources agree, then review the rendered Usage section to confirm the documented example is present and accurate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100