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

Suggested changes to kneth/realm-core-14.0.1 #6516

Merged
merged 5 commits into from
Feb 28, 2024

Conversation

kraenhansen
Copy link
Member

What, How & Why?

Instead of a lot of suggested changes in the GitHub PR UI, I thought a PR would be better.

@@ -146,7 +146,7 @@ export enum LogCategory {
/**
* Type for `Realm.setLogLevel`
*/
export type LogArgs = {
export type LogOptions = {
Copy link
Member Author

Choose a reason for hiding this comment

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

We tend to use "options" to describe the type of object passed as the sole argument to a function.

/**
* Represents an entry in the log.
*/
export type LogEntry = {
Copy link
Member Author

Choose a reason for hiding this comment

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

I believe "entry" is semantically more precise.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it reads better

Comment on lines -179 to -181
* @param category - The category (origin) of the log entry.
* @param level - The level of the log entry.
* @param message - The message of the log entry.
Copy link
Member Author

Choose a reason for hiding this comment

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

As these are not separate arguments to the callback, I've moved these descriptions into the properties on the object's type above.

@kneth kneth merged commit ef0aa0a into kneth/realm-core-14.0.1 Feb 28, 2024
28 of 31 checks passed
@kneth kneth deleted the kh/realm-core-14.0.1-feedback branch February 28, 2024 15:44
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants