-
-
Notifications
You must be signed in to change notification settings - Fork 203
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
chore: fix lint warnings in KeyringController
#5170
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you run yarn lint
do you see changes to eslint-warning-thresholds.json
? If so can you commit those too? You should see numbers go down.
* | ||
* Keyring object to return in fullUpdate | ||
* @property type - Keyring type |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: While @property
was certainly not the proper way to document type properties (it's not supported by TSdoc, TypeDoc, or VSCode), we can document them like this:
export type KeyringObject = {
/**
* Associated accounts
*/
accounts: string[];
/**
* Keyring type
*/
type: string;
};
It is nice to have docs for all properties, certainly if they're already documented. I see a few others were deleted in this PR as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea, I added some descriptions on KeyringObject
and KeyringControllerState
: 1334e78
@mcmire I updated the file, but now |
Explanation
Lint warnings in the
KeyringController
package have been fixedReferences
N/A
Changelog
No consumer-facing changes
Checklist