Typo in "Applied" docs - Generating Keys
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 170
- Forks
- 79
- PR merge metrics
- No merged PRs in 30d
Description
Should be Storing keys requires a read/write session. instead because:
- When a session is opened as
read onlyI get the following exception when generating a key withstore=True:
File "pkcs11/_pkcs11.pyx", line 488, in pkcs11._pkcs11.Session.generate_key
File "pkcs11/_errors.pyx", line 88, in pkcs11._pkcs11.assertRV
pkcs11.exceptions.SessionReadOnly
And when a session is opened as read/write, everything is fine.
- It just doesn't make sence..
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
Start at docs/applied.rst around line 367, using the linked revision to locate the sentence in the Generating Keys section. Confirm the wording against the reported read-only and read/write session behavior, then update the sentence and verify the rendered documentation reads correctly.
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
- 55/100