Skip to content

[r] clean up svds docs #206

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[r] clean up svds docs #206

wants to merge 2 commits into from

Conversation

immanuelazn
Copy link
Collaborator

I've noticed that the math doesn't get rendered correctly in Details. Looks like a copy-pasta from RSpectra, but \eqn blocks in \describe{\item{}} don't render correctly in our book. I did a minimal fix by converting the offending lines into code lines instead.

See the offending reference here.

Also fixed numbers and variables to be repesented as code blocks across params.

@immanuelazn immanuelazn requested a review from bnprks March 8, 2025 08:27
@bnprks
Copy link
Owner

bnprks commented Mar 9, 2025

Nice initiative on putting in a suggested fix, but I think the equation rendering is fixed already by a pending change that's currently in PR 189, as described in my comment on PR 168. It appears the pkgdown bug has a fix that was merged about a week ago, but it'll still be some time before it gets into a CRAN release I think.

It took me a while to re-figure out what was going on, because in the current main branch with a latest pkgdown installed it's impossible to get any equation to render correctly. I think with the fix I linked applied all of the equations render just fine (though some of your other changes like getting rid of the duplicate parameter comment seem good still).

Also, I think for things that are mostly fixing typos in docs/error messages/warning messages I think it's okay not to list as a separate item in the NEWS file

@immanuelazn
Copy link
Collaborator Author

Cool, thanks! I forgot about that change, was mainly concerned about how the \eqn blocks that were working in my #189 weren't working when copy pasted into this branch's lists. But probably should have done a due diligence check in params too.

In any case, I'll remove those changes and just keep the docs styling changes for the non equation blocks.

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