pharmaverse / pharmaverse/formatters
Refactoring documentation of class methods
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 20
- Forks
- 8
- Avg merge
- 12h 28m
- Merged PRs (30d)
- 1
Description
I have had this in mind for a bit as I often found myself lost in search of methods to, e.g., count the total number of printed lines (not nrow) of a specific table (see https://github.com/insightsengineering/formatters/issues/119). I am also aware of others that have similar problems. It could also be a problem of how I reach the documentation as I could not find any better way to retrieve the documentation page of nrow() for VTableTree if not by calling ?nrow,VTableTree-method``. Is there a better way?
All of this is still a working in progress as I came to this by trying to find documentation for the print method for VTableTree to do something similar to what I did in https://github.com/insightsengineering/rlistings/pull/113 which surfaces a bit of the printing machinery by referencing a couple of relevant parameters.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing documentation for VTableTree methods, especially nrow() and print(), along with formatters issue #119 and rlistings PR #113. Done means the relevant class-method documentation and the way to find it are clearly organized and discoverable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100