search

yihui / knitr

A general-purpose tool for dynamic report generation in R
https://yihui.org/knitr/
2.39k stars 879 forks source link

Sentence style in Rd #1481

Open yihui opened 6 years ago

yihui commented 6 years ago

Should use proper sentence styles in Rd (mostly roxygen comments for function arguments @param).

If you want to contribute and do not know roxygen, please note that you should only edit the roxygen comments in R source files. The .Rd files are automatically generated from roxygen.

More background info: https://yihui.name/en/2017/12/sentence-styles-knitr/

hughjonesd commented 6 years ago

I can help a bit.

yihui commented 6 years ago

Excellent. Thanks!

AlexAxthelm commented 6 years ago

I would love to help. Any suggestions on where to start?

yihui commented 6 years ago

@AlexAxthelm Actually @hughjonesd has started the work. I haven't reviewed his PR yet, but I suggest you work on the knitr web documentation instead: https://github.com/rbind/yihui/tree/master/content/knitr (in particular, improve options.md). Thanks!

yihui commented 6 years ago

@AlexAxthelm I just merged #1483 (thanks, David). I guess there isn't much documentation work left in this package, but please feel free to make further improvements in the roxygen comments.

The next step is to improve the knitr web documentation: https://yihui.name/knitr/ If you are familiar with GIT, the source files are under https://github.com/rbind/yihui/tree/master/content/knitr; you can edit all of them at once and submit one PR; if you are not familiar with GIT, you can click Edit this page on the website to make changes.

If you decide to work on it, please confirm it here so that other people won't work on it at the same time. Thank you!

AlexAxthelm commented 6 years ago

Absolutely I can do that.

donk3yzz commented 6 years ago

I know little about roxygen and it seems that I'm a little late. But I still hope to help if you need that.

yihui commented 6 years ago

@donk3yzz Please see my previous reply. You don't need to work on roxygen comments now, since @hughjonesd has pretty much finished the work. I need someone to help me update the knitr website, and @AlexAxthelm has agreed to do it, so I recommend you to work on other things, such as answering questions for me on Github: I maintain about 20 packages on CRAN, and it is quite a burden for me to answer questions on Github and StackOverflow. You can also help me fix bugs or implement new features. I have tagged possible issues that users can help resolve with Help needed.

yihui commented 6 years ago

Hi @AlexAxthelm, I wonder if you still have the time or interest to improve knitr's documentation website. It is totally fine if you don't (no worries at all), and I can ask @donk3yzz to try it. Thanks!

AlexAxthelm commented 6 years ago

I'm so sorry, this fell off my radar. I don't think that I'll be able to get to it before February, at the earliest. If @donk3yzz is willing and able, they might be a better choice, otherwise I'll work on it when I have a chance.

jienagu commented 5 years ago

I am happy to help improving knitr's documentation website. I am currently working on https://github.com/rbind/yihui/blob/master/content/knitr/options.md in my spare time.