Skip to content

PR #588 (issues #520 and #484): Update documentation for get_score_names()#590

Merged
nikosbosse merged 5 commits intomainfrom
improve-get_score_names
Jan 9, 2024
Merged

PR #588 (issues #520 and #484): Update documentation for get_score_names()#590
nikosbosse merged 5 commits intomainfrom
improve-get_score_names

Conversation

@nikosbosse
Copy link
Copy Markdown
Collaborator

@nikosbosse nikosbosse commented Jan 8, 2024

Description

This PR is a follow-up to #588 (related to issues #520 and #484).

I was a bit sloppy in the last PR, in particular with the documentation. This PR

  • updates the documentation for get_score_names(), replacing instances of "metric" with"scoring rule" and overall making it a lot more clear what's happening
  • adds functionality to warn if column names of a metric have been changed
  • adds unit tests
  • removes unrelated old tests that are no longer used
  • updates the News.md file

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title as follows: issue-number: PR title
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • I have built the package locally and run rebuilt docs using roxygen2.
  • My code follows the established coding standards and I have run lintr::lint_package() to check for style issues introduced by my changes.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

@nikosbosse nikosbosse requested a review from seabbs January 8, 2024 17:09
Copy link
Copy Markdown
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

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

LGTM

Co-authored-by: Sam Abbott <contact@samabbott.co.uk>
@nikosbosse nikosbosse merged commit 753d921 into main Jan 9, 2024
@nikosbosse nikosbosse deleted the improve-get_score_names branch January 9, 2024 18:09
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.

2 participants