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

reorganize NEWS #2223

Closed
MichaelChirico opened this issue Oct 3, 2023 · 4 comments · Fixed by #2224
Closed

reorganize NEWS #2223

MichaelChirico opened this issue Oct 3, 2023 · 4 comments · Fixed by #2224
Milestone

Comments

@MichaelChirico
Copy link
Collaborator

          Implementation looks good.

Should be put in a more prominent position in NEWS imo.
Technically, it is a breaking change. Or we could add a Section "Experimental features"

Originally posted by @AshesITR in #2177 (comment)

I also think we'd do well to have sections like "precision improvements" "recall improvements" that fit better with the nature of the package.

@MichaelChirico MichaelChirico added this to the 3.1.1 milestone Oct 3, 2023
@AshesITR
Copy link
Collaborator

AshesITR commented Oct 3, 2023

Apart from ML specialists, I'm afraid noone will understand precision / recall out of the box 😅

Would we consider false positives a bug?
If so, maybe improvements (more lints) vs. bug fixes (less lints)?

@MichaelChirico
Copy link
Collaborator Author

I think calling it a "bug" mixes up with what I consider bugs for lintr, namely that running the tool throws an unexpected error.

"Fixed false positives" feels a bit wordy too. precision/recall are the most concise descriptions... we could have a note at the top of the news explaining what they mean?

Otherwise we could lean into being very explicit "Code that wasn't meant to lint, now doesn't" "Code that was meant to lint, now does" along those lines

@MichaelChirico
Copy link
Collaborator Author

Using Type I/Type II error terminology might be understood by a wider audience of R users but I always have to look up which is which

@AshesITR
Copy link
Collaborator

AshesITR commented Oct 3, 2023

I like "Fixed false positives" (and "Improved true positives"?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants