Docstring unable to view the comment

[kartik1611]

I am unable to view the comments after changing the below function name and trying to view the comments , snippet and code below for reference purpose

Initially my function name was square but then changed to another variable and then tried to view the comments but I was unable to do so

### code for reference purpose
`
rm(list=ls(all=T))
library(docstring)
ab <- function(a){
#' @title :square function
#' @description : print the squares of the number
#'from 1 to the input given
#' @PARAM : input number
#' @output : provide the squares of the input range
for(i in 1:a){
b <- i^2
print(b)
}
}
?ab

`

I could not replicate this issue. Are you still affected by it?

[Dasonk]

I'm also unable to reproduce this error. If you have any further info let me know but I'm going to close this for the time being.

[KristanRomano]

I do have the same issue.

[Dasonk]

Interesting - I still can't reproduce but can you provide the output of sessionInfo() and Sys.info()? That might help with debugging.

[KristanRomano]

The above code is working now. But this one does not

library(docstring)
prova<-function(x){
#'@title prova
#'@description blabla
#'@PARAM x blabla
#'@output x-1
x-1
}

[mbuerg]

I had a similar problem. I fixed it by using docstring(my_function) rather than ?my_function. I got an loadNamespace(x) error regarding rstudioapi the first time, but could solve it by

install.packages("rstudioapi")
library(rstudioapi)

[Jiayou-Chao]

Interesting - I still can't reproduce but can you provide the output of sessionInfo() and Sys.info()? That might help with debugging.

I found that we can't have two functions that both have docstrings. They have the issue most likely because they had another function with docstrings.

library(docstring)
test1 <- function(x) {
  #' This is a test function
  #' @param x a number
  x <- x + 1
  return(x)
}

test2 <- function(x) {
  #' This is a test function
  #' @param x a number
  x <- x + 1
  return(x)
}

?test1
?test2

The output shows test1 is fine but not test2:

> ?test1

> ?test2
No documentation for ‘test2’ in specified packages and libraries:
you could try ‘??test2’

[Jiayou-Chao]

I had a similar problem. I fixed it by using docstring(my_function) rather than ?my_function. I got an loadNamespace(x) error regarding rstudioapi the first time, but could solve it by

install.packages("rstudioapi") library(rstudioapi)

This is very helpful information. If you run docstring(my_function) once, you will be able to run ?my_function in the future.

[Dasonk]

Interesting. I'll investigate. Are you using RStudio? Does the problem persist if you use R outside of RStudio?

[Jiayou-Chao]

Interesting. I'll investigate. Are you using RStudio? Does the problem persist if you use R outside of RStudio?

Yes, I use RStudio. I tried RGUI again, and got the same error.

[Jiayou-Chao]

It seems there has already been a pull request to fix it.
#29 (comment)