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

document about manuals and .texi format #156

Open
SaranjeetKaur opened this issue Jul 1, 2023 · 0 comments
Open

document about manuals and .texi format #156

SaranjeetKaur opened this issue Jul 1, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@SaranjeetKaur
Copy link
Collaborator

The manuals do not use the same infrastructure as the help files. Specifically, as a GNU project, R uses GNU Texinfo to create the R manuals (https://www.gnu.org/software/texinfo/), so the source of the manuals are .texi files, e.g. https://github.com/r-devel/r-svn/blob/master/doc/manual/R-exts.texi, with different markup from .Rd files. Since .texi is not an R-specific format there is no need to document it fully here, but we should document that manuals use this format. You may need to create a new issue to add this in later in the chapter.

Also people may suggest changes without providing a formal patch.

I'm not sure that proposals for completely new documentation would get very far - that would certainly be unusual, so we shouldn't promote that as a typical way to contribute.

Originally posted by @hturner in #144 (comment)

@SaranjeetKaur SaranjeetKaur added the documentation Improvements or additions to documentation label Jul 1, 2023
@hturner hturner added the good first issue Good for newcomers label Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants