I have two questions regarding the documentation:
First, I wonder what steps I have to take such that changes in the documentation are propagated. That is if I change a description in *.a.yaml what steps are needed that they are written to the R help file? I tried devtools::install() and devtools::document() but that does not seem enough.
Second, where are the ui: parts of the description tag shown? I cannot locate them in jamovi.
Questions Regarding Documentation
Re: Questions Regarding Documentation
Still would appreciate help on this if someone finds the time
.
![smiling face with open mouth and smiling... :)](./images/smilies/emojione/1f604.png)
Re: Questions Regarding Documentation
so you specify the description in the .yaml files, i.e.
https://github.com/jamovi/jmv/blob/master/jamovi/ttestis.a.yaml#L65-L71
then running jmvtools places this in the corresponding .h.R file, like this
https://github.com/jamovi/jmv/blob/master/R/ttestis.h.R#L763-L769
running devtools::document() places that content in the .Rd files
https://github.com/cran/jmv/blob/master/man/ttestIS.Rd#L17-L18
and then that shows up in the documentation
https://www.rdocumentation.org/packages/jmv/versions/2.3.4/topics/ttestIS
jonathon
https://github.com/jamovi/jmv/blob/master/jamovi/ttestis.a.yaml#L65-L71
then running jmvtools places this in the corresponding .h.R file, like this
https://github.com/jamovi/jmv/blob/master/R/ttestis.h.R#L763-L769
running devtools::document() places that content in the .Rd files
https://github.com/cran/jmv/blob/master/man/ttestIS.Rd#L17-L18
and then that shows up in the documentation
https://www.rdocumentation.org/packages/jmv/versions/2.3.4/topics/ttestIS
jonathon
Re: Questions Regarding Documentation
Thanks Jonathon! I was missing the jmvtools part. I hate to steal your time more than is needed but would you mind also addressing the second question about where the ui parts of the documentation are shown?
Re: Questions Regarding Documentation
https://dev.jamovi.org/ui-basic-design.html
cheers
jonathon
cheers
jonathon