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

[R] Docs for function arguments format second paragraph as code block #10329

Closed
david-cortes opened this issue May 25, 2024 · 3 comments
Closed

Comments

@david-cortes
Copy link
Contributor

In a previous PR for R documentation: #9906

The roxygen options were changed to use markdown mode in all docs.

After this change, some docs that have multiple paragraphs are incorrectly putting everything beyond the first paragraph into a code section, such as argument base_margin in xgb.DMatrix:

\if{html}{\out{<div class="sourceCode">}}\preformatted{ In the case of multi-output models, one can also pass multi-dimensional base_margin.

Changing back to non-markdown mode solves the issue (e.g. by adding @noMd), but it's unfortunately not possible to do this only for one function argument, only for a whole .Rd file, so not sure how to solve this.

The affected files can be found by searching for something like this in the man/ folder:

\if{html}{\out{<div class="sourceCode">}}\preformatted{

CC @mayer79

@mayer79
Copy link
Contributor

mayer79 commented May 25, 2024

IMHO we should continue switching to the modern style. I can dedicate more time into this, but some help would be greatly appreciated (sooo much docu...).

Formatting issues like the one you have identified can be fixed, I am pretty sure.

@trivialfis
Copy link
Member

but some help would be greatly appreciated

Feel free to ping me if there's anything I can help.

@mayer79
Copy link
Contributor

mayer79 commented Aug 26, 2024

Fixed in #10733.

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

No branches or pull requests

3 participants