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

Docs: mark global generateSessionKeys's encryptionKeys as optional #1596

Merged
merged 1 commit into from Feb 17, 2023

Conversation

LucienLeMagicien
Copy link
Contributor

generateSessionKeys calls Message.generateSessionKeys, which calls helper.js's getPreferredAlgo, which returns config.preferredSymmetricAlgorithm when the encryptionKeys array is empty.
encryptionKeys also defaults to an empty array, and Message.generateSessionkeys's encryptionKeys is properly marked as optional, so this seems to just be an oversight from the doc.

I'm not familiar with the code or jsdoc or if there's a particular doc style, so feel free to edit!

In any case, it looks like it renders correctly:
Screenshot of the updated doc for generateSessionkey

Copy link
Member

@twiss twiss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks!

@twiss twiss merged commit 3e6e8d0 into openpgpjs:main Feb 17, 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.

None yet

2 participants