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

Improve accessibility of links & clarify technical language & correct spelling #187

Merged
merged 4 commits into from
Feb 4, 2025

Conversation

RayStick
Copy link
Member

@RayStick RayStick commented Feb 3, 2025

Closes #185

@Lextuga007 this PR is responding to 3 of your review comments, are you okay to review it? No problem if not, I can get another collaborator to do so. I just wanted to check I had responded to your comments appropriately, specifically regarding accessibility of links.

Checklist for the author of this PR:

  • [if package files were edited] I have run these checks locally:
    • devtools::document() to generates the .Rd files from any updated roxygen comments.
    • codemetar::write_codemeta() to ensures the metadata file is up to date.
    • styler::style_pkg() to ensure consistent code styling that match the guidelines.
    • devtools::check() for a comprehensive package check. I have resolved any warnings or errors, or written them here in the PR, for discussion.
  • The code base and the documentation files match (they both reflect any recent changes).
  • The title of this PR is clear and self-explantory.
  • I have added any appropriate labels to this PR.
  • This PR is now ready for review (and I have removed the draft PR status).

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 3, 2025
@RayStick RayStick marked this pull request as ready for review February 3, 2025 14:21
@RayStick RayStick added this to the rOpenSci Review Process milestone Feb 3, 2025
Copy link
Contributor

Choose a reason for hiding this comment

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

Should the name of the file also be changed?

Copy link
Member Author

Choose a reason for hiding this comment

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

the function 'consensus_on_mismatch' is within
https://github.com/aim-rsf/mapmetadata/blob/R2-2_R2-3_R2-5/R/compare.R
So we should be sorted on all the renaming :)
Let me know if I am missing something!

Copy link
Contributor

Choose a reason for hiding this comment

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

I could have been clearer - apologies! The file itself is called test-consensus_on_mistmatch.R and now that the function has been changed the file name should change too I guess?

Copy link
Member Author

@RayStick RayStick Feb 4, 2025

Choose a reason for hiding this comment

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

Yep I follow =D
This filename has been changed in the branch: https://github.com/aim-rsf/mapmetadata/blob/R2-2_R2-3_R2-5/tests/testthat/test-consensus_on_mismatch.R
Is that what you mean? Apologies if I am missing something obvious

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 in it used to be

tests/testthat/test-concensus_on_mismatch.R

now it is

tests/testthat/test-consensus_on_mismatch.R

vignettes/mapmetadata.Rmd Outdated Show resolved Hide resolved
Copy link

codecov bot commented Feb 4, 2025

Codecov Report

Attention: Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
R/metadata_map.R 66.66% 1 Missing ⚠️
Files with missing lines Coverage Δ
R/compare.R 100.00% <100.00%> (ø)
R/map_compare.R 100.00% <100.00%> (ø)
R/metadata_map.R 73.24% <66.66%> (ø)

@RayStick
Copy link
Member Author

RayStick commented Feb 4, 2025

@Lextuga007 thanks for your comments, I am going to merge this branch into main if that's okay
(Don't worry about the code coverage check failing, I will resolve that later)

@RayStick RayStick merged commit 639ec6f into main Feb 4, 2025
8 of 9 checks passed
@RayStick RayStick deleted the R2-2_R2-3_R2-5 branch February 4, 2025 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve accessibility of links & clarify technical language & correct spelling (Reviewer 2, points 2 & 3 & 5)
2 participants