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

Email for typo in manuals #101

Closed
SaranjeetKaur opened this issue Oct 21, 2022 · 1 comment · Fixed by #152
Closed

Email for typo in manuals #101

SaranjeetKaur opened this issue Oct 21, 2022 · 1 comment · Fixed by #152
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@SaranjeetKaur
Copy link
Collaborator

Would this also apply to the manuals?

Originally posted by @bettinagruen in #66 (comment)

@SaranjeetKaur SaranjeetKaur self-assigned this Apr 4, 2023
@SaranjeetKaur SaranjeetKaur added the documentation Improvements or additions to documentation label May 9, 2023
@SaranjeetKaur SaranjeetKaur linked a pull request Jun 14, 2023 that will close this issue
@SaranjeetKaur
Copy link
Collaborator Author

SaranjeetKaur commented Jun 14, 2023

Discussed this issue with Tomas Kalibera and Uwe Ligges.

Discussion with Tomas:

Dear Saranjeet,

On 6/2/23 09:32, Saranjeet Kaur wrote:
Dear Tomas,

I am writing this email in the context of the [R dev guide](https://contributor.r-project.org/rdevguide/index.html). We have written a sentence in the dev guide which says:

"If you find some typo or problem on [CRAN](https://cran.r-project.org/) after checking the problem or typo you can write a polite email to `[cran-sysadmin@r-project.org](mailto:cran-sysadmin@r-project.org)` and one of the R-core members working with CRAN."

Myself and Bettina Gruen were discussing whether if someone finds a typo or issue in one of the R manuals then should they also report it to `[cran-sysadmin@r-project.org](mailto:cran-sysadmin@r-project.org)`.

Could you please provide advice on the same or re-direct me to someone who might have some idea about this?

the R manuals which are part of the R source distribution (i.e. https://svn.r-project.org/R/trunk/doc/manual), so including R-exts, R-intro, R-admin, rw-FAQ, ... are maintained as part of the source, so by the R Core team. If it is just a typo, feel free to write to the R-devel mailing list (and if a single or just several typos, just say it in English, no need to send a patch). This is a common practice in this case.

In principle, one can also submit a bug report via R bugzilla, but I think that it is an overkill for one or several typos.

Best
Tomas

Discussion with Uwe:

On 02.06.2023 09:33, Saranjeet Kaur wrote:
> Dear Admin,
> 
> I am writing this email in the context of theR dev guide 
> <https://contributor.r-project.org/rdevguide/index.html>. We have 
> written a sentence in the dev guide which says:
> 
> "If you find some typo or problem on [CRAN](https://cran.r-project.org/ 
> <https://cran.r-project.org/>) after checking the problem or typo you can 
> write a polite email to `[cran-sysadmin@r-project.org](mailto:cran-sysadmin@r-project.org) 
> <mailto:[cran-sysadmin@r-project.org](mailto:cran-sysadmin@r-project.org)>`and one of the R-core members 
> working with CRAN."
> 
> Myself and Bettina Gruen were discussing whether if someone finds a typo 

CCing Bettina.

Hmm, cran-sysadmin is the address of the team that maintains the 
hardware/OS of the CRAN machines in Vienna, so the wrong address.


For the CRAN webpages [CRAN@r-project.org](mailto:CRAN@r-project.org) seems to be better.
But not the web pages about particular packages that are auto generated 
from the package contentr, hence is to be fixed by the corresponding 
package maintainer.

For improvements of the R-manuals, writing a bug report seems the 
correct approach.

Best,
Uwe Ligges

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant