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

[DOC-FIX] switch from Rd to markdown documentation #3277

Open
1 of 3 tasks
yitao-li opened this issue Aug 14, 2020 · 2 comments
Open
1 of 3 tasks

[DOC-FIX] switch from Rd to markdown documentation #3277

yitao-li opened this issue Aug 14, 2020 · 2 comments
Labels
area/docs Documentation issues

Comments

@yitao-li
Copy link
Contributor

yitao-li commented Aug 14, 2020

Thank you for submitting an issue. Please refer to our issue policy for information on what types of issues we address.

Please fill in this documentation issue template to ensure a timely and thorough response.

Willingness to contribute

The MLflow Community encourages documentation fix contributions. Would you or another member of your organization be willing to contribute a fix for this documentation issue to the MLflow code base?

  • Yes. I can contribute a documentation fix independently.
  • Yes. I would be willing to contribute a document fix with guidance from the MLflow community.
  • No. I cannot contribute a documentation fix at this time.

URL(s) with the issue:

As suggested by Lorenz in yitao-li#1

Description of proposal (what needs changing):

Provide a clear description. Why is the proposed documentation better?

Markdown syntax is more lightweight compared to Rd

@yitao-li yitao-li added the area/docs Documentation issues label Aug 14, 2020
@lorenzwalthert
Copy link
Contributor

I'd suggest to use https://github.com/r-lib/roxygen2md or usethis::use_roxygen_md()and compare the Rd diff. Markdown syntax is simpler than the Rd syntax, e.g. for cross-linking and many people are already familiar with it.

@dmatrix
Copy link
Contributor

dmatrix commented Aug 17, 2020

@lorenzwalthert Thanks for responding. Presumably, you'll review @yitao-li PR once filed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation issues
Projects
None yet
Development

No branches or pull requests

3 participants