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

proper linking #118

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

proper linking #118

wants to merge 1 commit into from

Conversation

rhijmans
Copy link

@rhijmans rhijmans commented Jan 5, 2025

Hi Adam,

I fixed a link in the convHull entry of the manual to that method in the "terra" manual. You were linking to a particular file

\link[terra:convhull]{terra::convHull()}}

You can link to the package::method like this

\link[terra]{convHull}}

That is a better approach, because it won't break if the filename changes. (I noticed this in a reverse dependency check). I assume you have many more of these.

Cheers, Robert

PS: I now see that you use Roxygen to generate these, so the PR is not very useful. I do not use Roxygen, but I assume you can fix it with that system as well.

@adamlilith
Copy link
Owner

Hi Robert,

Thanks for noting this. Yes, I am using roxygen2, which creates the \link[package:method]{package::method()}}` pattern in the RD files, which I actually never edit. It looks like roxygen does this for any links to any methods in any package. Given >200 methods docs, I'm going to stay with the roxygen format until it breaks. But thank you for pointing this out.

Adam

@adamlilith adamlilith closed this Jan 5, 2025
@adamlilith adamlilith reopened this Jan 5, 2025
@rhijmans
Copy link
Author

rhijmans commented Jan 5, 2025

The reason that I reported it is that it was breaking --- that is how I detected it. I have reverted my change but that (and others) will happen eventually, and that creates additional work with CRAN submissions.

Can you use the below in convHull.r and tell Roxygen to not interpret it?

#' \seealso{ \link[terra]{convHull}, \link[sf]{st_convex_hull}, module `v.hull` in **GRASS**}

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